From 771f7c427b5ca0ff1c50f049484b2da3db91ae12 Mon Sep 17 00:00:00 2001 From: coatless Date: Tue, 14 Nov 2023 08:35:41 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20coatless?= =?UTF-8?q?-rpkg/assignr@f5424dafe2e46fbb72db56bd2084af629dee8f59=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pkgdown.yml | 2 +- reference/assignr.html | 14 +++++--------- search.json | 2 +- 3 files changed, 7 insertions(+), 11 deletions(-) diff --git a/pkgdown.yml b/pkgdown.yml index faeb298..88cd87e 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 2.19.2 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2023-11-14T07:31Z +last_built: 2023-11-14T08:35Z urls: reference: https://r-pkg.thecoatlessprofessor.com/assignr/reference article: https://r-pkg.thecoatlessprofessor.com/assignr/articles diff --git a/reference/assignr.html b/reference/assignr.html index 52f0596..cb29cce 100644 --- a/reference/assignr.html +++ b/reference/assignr.html @@ -137,23 +137,19 @@

Examples# Generate both PDF and HTML outputs for assign and solution. assignr(hw00_file, "test") #> Building hw00-assign files -#> Warning: error in running command -#> ! sh: 1: pdflatex: not found -#> Error: LaTeX failed to compile hw00-assign.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See hw00-assign.log for more info. +#> Creating a zip file for hw00-assign +#> Building hw00-soln files +#> Creating a zip file for hw00-soln # Generate only the assignment assignr(hw00_file, "assignment-set", soln_file = FALSE) #> Building hw00-assign files -#> Warning: error in running command -#> ! sh: 1: pdflatex: not found -#> Error: LaTeX failed to compile hw00-assign.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See hw00-assign.log for more info. +#> Creating a zip file for hw00-assign # Generate only the solution assignr(hw00_file, "solution-set", assign_file = FALSE) #> Building hw00-soln files -#> Warning: error in running command -#> ! sh: 1: pdflatex: not found -#> Error: LaTeX failed to compile hw00-soln.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See hw00-soln.log for more info. +#> Creating a zip file for hw00-soln # Create only HTML documents for both assignment and solution files. assignr(hw00_file, "test-html", output_format = "html_document") diff --git a/search.json b/search.json index 27ab2e5..6032b1b 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"David Dalpiaz. Author, copyright holder. James Balamuta. Author, maintainer, copyright holder.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Dalpiaz D, Balamuta J (2023). assignr: Create Homework Assignments Solutions using 'RMarkdown'. R package version 0.0.1, https://r-pkg.thecoatlessprofessor.com/assignr/, https://github.com/coatless-rpkg/assignr.","code":"@Manual{, title = {assignr: Create Homework Assignments and Solutions using 'RMarkdown'}, author = {David Dalpiaz and James Balamuta}, year = {2023}, note = {R package version 0.0.1, https://r-pkg.thecoatlessprofessor.com/assignr/}, url = {https://github.com/coatless-rpkg/assignr}, }"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"assignr","dir":"","previous_headings":"","what":"Create Homework Assignments and Solutions using RMarkdown","title":"Create Homework Assignments and Solutions using RMarkdown","text":"Tools creating homework assignments solutions using RMarkdown.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"motivation","dir":"","previous_headings":"","what":"Motivation","title":"Create Homework Assignments and Solutions using RMarkdown","text":"Writing homework assignments students age RMarkdown necessitates creation two separate documents – assign.Rmd soln.Rmd. goal assignr create one document main.Rmd can broken apart two documents. Thus, longer need copy paste assign soln documents contents together one file. Example workflow assignr","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Create Homework Assignments and Solutions using RMarkdown","text":"assignr available via GitHub. install package GitHub, can type:","code":"install.packages(\"devtools\") devtools::install_github(\"coatless-rpkg/assignr\")"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Create Homework Assignments and Solutions using RMarkdown","text":"use assignr, create Rmd file named WXYZ-main.Rmd, WXYZ hw00. Within file, add code chunks one following chunk options: mark solution indicate directions specifying text directions appear solution file, use latter chunk option, set code chunk engine asis, e.g. , R, run: Example Output: Previews contained file shown next.","code":"```{asis name, directions = TRUE} The goal of the following exercise is... ``` # Render output assignr(\"hw00-main.Rmd\") hw00 ├── hw00-assign │ ├── hw00-assign.Rmd │ ├── hw00-assign.html │ ├── hw00-assign.pdf │ └── hw00-assign.zip └── hw00-soln ├── hw00-soln.Rmd ├── hw00-soln.html ├── hw00-soln.pdf └── hw00-soln.zip"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"instructor-main","dir":"","previous_headings":"Usage","what":"Instructor Main","title":"Create Homework Assignments and Solutions using RMarkdown","text":"main file, denoted *-main.Rmd, content – including solutions – placed. example contents, please see hw00-main.Rmd document ships package.","code":"library(\"assignr\") file.show(get_example_filepath(\"hw00-main.Rmd\")) --- title: 'Homework X' author: \"Prof. Name\" date: 'Due: Friday, Month Day by 1:59 PM CDT' output: html_document: theme: readable toc: yes --- # Exercise 1 (Introductory `R`) ```{asis, directions = TRUE} For this exercise, we will create a couple different vectors. ``` **(a)** Create two vectors `x0` and `x1`. Each should have a length of 25 and store the following: - `x0`: Each element should be the value `10`. - `x1`: The first 25 cubed numbers, starting from `1.` (e.g. `1`, `8`, `27`, et cetera) ```{asis, solution = TRUE} **Solution:** ``` ```{r, solution = TRUE} x0 = rep(10, 25) x1 = (1:25) ^ 3 ```"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"student-assignment","dir":"","previous_headings":"Usage","what":"Student Assignment","title":"Create Homework Assignments and Solutions using RMarkdown","text":"Within section, assignment rmarkdown file given students displayed. PDF Rendering hw00-assign.Rmd","code":"--- title: 'Homework X' author: \"Prof. Name\" date: 'Due: Friday, Month Day by 1:59 PM CDT' output: html_document: theme: readable toc: yes --- # Exercise 1 (Introductory `R`) For this exercise, we will create a couple different vectors. **(a)** Create two vectors `x0` and `x1`. Each should have a length of 25 and store the following: - `x0`: Each element should be the value `10`. - `x1`: The first 25 cubed numbers, starting from `1.` (e.g. `1`, `8`, `27`, et cetera)"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"solutions","dir":"","previous_headings":"Usage","what":"Solutions","title":"Create Homework Assignments and Solutions using RMarkdown","text":"Lastly, assignment rmarkdown file contains solutions respective output. PDF Rendering hw00-soln.Rmd","code":"--- title: 'Homework X' author: \"Prof. Name\" date: 'Due: Friday, Month Day by 1:59 PM CDT' output: html_document: theme: readable toc: yes --- # Exercise 1 (Introductory `R`) **(a)** Create two vectors `x0` and `x1`. Each should have a length of 25 and store the following: - `x0`: Each element should be the value `10`. - `x1`: The first 25 cubed numbers, starting from `1.` (e.g. `1`, `8`, `27`, et cetera) **Solution:** ```{r, solution = TRUE} x0 = rep(10, 25) x1 = (1:25) ^ 3 ```"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"authors","dir":"","previous_headings":"","what":"Authors","title":"Create Homework Assignments and Solutions using RMarkdown","text":"James Joseph Balamuta David Dalpiaz","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"license","dir":"","previous_headings":"","what":"License","title":"Create Homework Assignments and Solutions using RMarkdown","text":"GPL (>= 2)","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr-package.html","id":null,"dir":"Reference","previous_headings":"","what":"assignr: Create Homework Assignments and Solutions using 'RMarkdown' — assignr-package","title":"assignr: Create Homework Assignments and Solutions using 'RMarkdown' — assignr-package","text":"Writing homework assignments students age 'RMarkdown' necessitates creation two separate documents -- assign.Rmd soln.Rmd. goal assignr create one document main.Rmd can broken apart two documents. Thus, longer need copy paste assign soln documents contents together one file.","code":""},{"path":[]},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"assignr: Create Homework Assignments and Solutions using 'RMarkdown' — assignr-package","text":"Maintainer: James Balamuta balamut2@illinois.edu [copyright holder] Authors: David Dalpiaz dalpiaz2@illinois.edu [copyright holder]","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Homework and Assignment Materials — assignr","title":"Create Homework and Assignment Materials — assignr","text":"Transforms RMarkdown file two separate files: filename-assign filename-solutions","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Homework and Assignment Materials — assignr","text":"","code":"assignr( file, output_dir = NULL, output_format = c(\"html_document\", \"pdf_document\"), assign_file = TRUE, soln_file = TRUE, zip_files = TRUE, render_files = TRUE )"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Homework and Assignment Materials — assignr","text":"file Input .Rmd file -main.Rmd filename. output_dir Output directory. Defaults name prefix filename. output_format Output file type. rmarkdown::render() output format work. Defaults generating HTML PDF output c(\"html_document\", \"pdf_document\"). assign_file Generate Student Assignment Material. Default TRUE. soln_file Generate Solution Material. Default TRUE. zip_files Create zip file containing relevant materials. Default TRUE. render_files Create HTML PDF output Rmd file. Default TRUE.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Homework and Assignment Materials — assignr","text":"function generate assignment files students solution keys instructors.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create Homework and Assignment Materials — assignr","text":"file parameter must suffix -main.Rmd. reason requiring naming scheme work done \"main\" document. enforcing naming requirement, prevent work overridden.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"folder-structure","dir":"Reference","previous_headings":"","what":"Folder structure","title":"Create Homework and Assignment Materials — assignr","text":"output_dir specified, used parent two folders: *-assign *-sol, * given part preceeding -main.Rmd. Inside folders, html, pdf, Rmd documents alongside zip folder containing documents.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create Homework and Assignment Materials — assignr","text":"","code":"# Obtain an example file hw00_file = get_example_filepath(\"hw00-main.Rmd\") if(interactive()) { file.show(hw00_file) } # Generate both PDF and HTML outputs for assign and solution. assignr(hw00_file, \"test\") #> Building hw00-assign files #> Warning: error in running command #> ! sh: 1: pdflatex: not found #> Error: LaTeX failed to compile hw00-assign.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See hw00-assign.log for more info. # Generate only the assignment assignr(hw00_file, \"assignment-set\", soln_file = FALSE) #> Building hw00-assign files #> Warning: error in running command #> ! sh: 1: pdflatex: not found #> Error: LaTeX failed to compile hw00-assign.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See hw00-assign.log for more info. # Generate only the solution assignr(hw00_file, \"solution-set\", assign_file = FALSE) #> Building hw00-soln files #> Warning: error in running command #> ! sh: 1: pdflatex: not found #> Error: LaTeX failed to compile hw00-soln.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See hw00-soln.log for more info. # Create only HTML documents for both assignment and solution files. assignr(hw00_file, \"test-html\", output_format = \"html_document\") #> Building hw00-assign files #> Creating a zip file for hw00-assign #> Building hw00-soln files #> Creating a zip file for hw00-soln # \\dontshow{ # Clean up generated directories unlink(\"test\", recursive = TRUE) unlink(\"assignment-set\", recursive = TRUE) unlink(\"solution-set\", recursive = TRUE) unlink(\"test-html\", recursive = TRUE) # }"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve example file path — get_example_filepath","title":"Retrieve example file path — get_example_filepath","text":"Obtains file path example Rmd package.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve example file path — get_example_filepath","text":"","code":"get_example_filepath(x)"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve example file path — get_example_filepath","text":"x character containing name example Rmd.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve example file path — get_example_filepath","text":"File path example file ships package.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Retrieve example file path — get_example_filepath","text":"following example files ship package: hw00-main.Rmd","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve example file path — get_example_filepath","text":"","code":"get_example_filepath(\"hw00-main.Rmd\") #> [1] \"/home/runner/work/_temp/Library/assignr/example_rmd/hw00-main.Rmd\""},{"path":[]},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/news/index.html","id":"features-0-0-1","dir":"Changelog","previous_headings":"","what":"Features","title":"assignr 0.0.1","text":"Automatically generate solution key assignment asingle .Rmd file via assignr(\"hwXX-main.Rmd\"). Compress individual solution key assignment files via zip. Automatically deploy GitHub Pages website default output directory set /docs.","code":""}] +[{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"David Dalpiaz. Author, copyright holder. James Balamuta. Author, maintainer, copyright holder.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Dalpiaz D, Balamuta J (2023). assignr: Create Homework Assignments Solutions using 'RMarkdown'. R package version 0.0.1, https://r-pkg.thecoatlessprofessor.com/assignr/, https://github.com/coatless-rpkg/assignr.","code":"@Manual{, title = {assignr: Create Homework Assignments and Solutions using 'RMarkdown'}, author = {David Dalpiaz and James Balamuta}, year = {2023}, note = {R package version 0.0.1, https://r-pkg.thecoatlessprofessor.com/assignr/}, url = {https://github.com/coatless-rpkg/assignr}, }"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"assignr","dir":"","previous_headings":"","what":"Create Homework Assignments and Solutions using RMarkdown","title":"Create Homework Assignments and Solutions using RMarkdown","text":"Tools creating homework assignments solutions using RMarkdown.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"motivation","dir":"","previous_headings":"","what":"Motivation","title":"Create Homework Assignments and Solutions using RMarkdown","text":"Writing homework assignments students age RMarkdown necessitates creation two separate documents – assign.Rmd soln.Rmd. goal assignr create one document main.Rmd can broken apart two documents. Thus, longer need copy paste assign soln documents contents together one file. Example workflow assignr","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Create Homework Assignments and Solutions using RMarkdown","text":"assignr available via GitHub. install package GitHub, can type:","code":"install.packages(\"devtools\") devtools::install_github(\"coatless-rpkg/assignr\")"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Create Homework Assignments and Solutions using RMarkdown","text":"use assignr, create Rmd file named WXYZ-main.Rmd, WXYZ hw00. Within file, add code chunks one following chunk options: mark solution indicate directions specifying text directions appear solution file, use latter chunk option, set code chunk engine asis, e.g. , R, run: Example Output: Previews contained file shown next.","code":"```{asis name, directions = TRUE} The goal of the following exercise is... ``` # Render output assignr(\"hw00-main.Rmd\") hw00 ├── hw00-assign │ ├── hw00-assign.Rmd │ ├── hw00-assign.html │ ├── hw00-assign.pdf │ └── hw00-assign.zip └── hw00-soln ├── hw00-soln.Rmd ├── hw00-soln.html ├── hw00-soln.pdf └── hw00-soln.zip"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"instructor-main","dir":"","previous_headings":"Usage","what":"Instructor Main","title":"Create Homework Assignments and Solutions using RMarkdown","text":"main file, denoted *-main.Rmd, content – including solutions – placed. example contents, please see hw00-main.Rmd document ships package.","code":"library(\"assignr\") file.show(get_example_filepath(\"hw00-main.Rmd\")) --- title: 'Homework X' author: \"Prof. Name\" date: 'Due: Friday, Month Day by 1:59 PM CDT' output: html_document: theme: readable toc: yes --- # Exercise 1 (Introductory `R`) ```{asis, directions = TRUE} For this exercise, we will create a couple different vectors. ``` **(a)** Create two vectors `x0` and `x1`. Each should have a length of 25 and store the following: - `x0`: Each element should be the value `10`. - `x1`: The first 25 cubed numbers, starting from `1.` (e.g. `1`, `8`, `27`, et cetera) ```{asis, solution = TRUE} **Solution:** ``` ```{r, solution = TRUE} x0 = rep(10, 25) x1 = (1:25) ^ 3 ```"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"student-assignment","dir":"","previous_headings":"Usage","what":"Student Assignment","title":"Create Homework Assignments and Solutions using RMarkdown","text":"Within section, assignment rmarkdown file given students displayed. PDF Rendering hw00-assign.Rmd","code":"--- title: 'Homework X' author: \"Prof. Name\" date: 'Due: Friday, Month Day by 1:59 PM CDT' output: html_document: theme: readable toc: yes --- # Exercise 1 (Introductory `R`) For this exercise, we will create a couple different vectors. **(a)** Create two vectors `x0` and `x1`. Each should have a length of 25 and store the following: - `x0`: Each element should be the value `10`. - `x1`: The first 25 cubed numbers, starting from `1.` (e.g. `1`, `8`, `27`, et cetera)"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"solutions","dir":"","previous_headings":"Usage","what":"Solutions","title":"Create Homework Assignments and Solutions using RMarkdown","text":"Lastly, assignment rmarkdown file contains solutions respective output. PDF Rendering hw00-soln.Rmd","code":"--- title: 'Homework X' author: \"Prof. Name\" date: 'Due: Friday, Month Day by 1:59 PM CDT' output: html_document: theme: readable toc: yes --- # Exercise 1 (Introductory `R`) **(a)** Create two vectors `x0` and `x1`. Each should have a length of 25 and store the following: - `x0`: Each element should be the value `10`. - `x1`: The first 25 cubed numbers, starting from `1.` (e.g. `1`, `8`, `27`, et cetera) **Solution:** ```{r, solution = TRUE} x0 = rep(10, 25) x1 = (1:25) ^ 3 ```"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"authors","dir":"","previous_headings":"","what":"Authors","title":"Create Homework Assignments and Solutions using RMarkdown","text":"James Joseph Balamuta David Dalpiaz","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/index.html","id":"license","dir":"","previous_headings":"","what":"License","title":"Create Homework Assignments and Solutions using RMarkdown","text":"GPL (>= 2)","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr-package.html","id":null,"dir":"Reference","previous_headings":"","what":"assignr: Create Homework Assignments and Solutions using 'RMarkdown' — assignr-package","title":"assignr: Create Homework Assignments and Solutions using 'RMarkdown' — assignr-package","text":"Writing homework assignments students age 'RMarkdown' necessitates creation two separate documents -- assign.Rmd soln.Rmd. goal assignr create one document main.Rmd can broken apart two documents. Thus, longer need copy paste assign soln documents contents together one file.","code":""},{"path":[]},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"assignr: Create Homework Assignments and Solutions using 'RMarkdown' — assignr-package","text":"Maintainer: James Balamuta balamut2@illinois.edu [copyright holder] Authors: David Dalpiaz dalpiaz2@illinois.edu [copyright holder]","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Homework and Assignment Materials — assignr","title":"Create Homework and Assignment Materials — assignr","text":"Transforms RMarkdown file two separate files: filename-assign filename-solutions","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Homework and Assignment Materials — assignr","text":"","code":"assignr( file, output_dir = NULL, output_format = c(\"html_document\", \"pdf_document\"), assign_file = TRUE, soln_file = TRUE, zip_files = TRUE, render_files = TRUE )"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Homework and Assignment Materials — assignr","text":"file Input .Rmd file -main.Rmd filename. output_dir Output directory. Defaults name prefix filename. output_format Output file type. rmarkdown::render() output format work. Defaults generating HTML PDF output c(\"html_document\", \"pdf_document\"). assign_file Generate Student Assignment Material. Default TRUE. soln_file Generate Solution Material. Default TRUE. zip_files Create zip file containing relevant materials. Default TRUE. render_files Create HTML PDF output Rmd file. Default TRUE.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Homework and Assignment Materials — assignr","text":"function generate assignment files students solution keys instructors.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create Homework and Assignment Materials — assignr","text":"file parameter must suffix -main.Rmd. reason requiring naming scheme work done \"main\" document. enforcing naming requirement, prevent work overridden.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"folder-structure","dir":"Reference","previous_headings":"","what":"Folder structure","title":"Create Homework and Assignment Materials — assignr","text":"output_dir specified, used parent two folders: *-assign *-sol, * given part preceeding -main.Rmd. Inside folders, html, pdf, Rmd documents alongside zip folder containing documents.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/assignr.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create Homework and Assignment Materials — assignr","text":"","code":"# Obtain an example file hw00_file = get_example_filepath(\"hw00-main.Rmd\") if(interactive()) { file.show(hw00_file) } # Generate both PDF and HTML outputs for assign and solution. assignr(hw00_file, \"test\") #> Building hw00-assign files #> Creating a zip file for hw00-assign #> Building hw00-soln files #> Creating a zip file for hw00-soln # Generate only the assignment assignr(hw00_file, \"assignment-set\", soln_file = FALSE) #> Building hw00-assign files #> Creating a zip file for hw00-assign # Generate only the solution assignr(hw00_file, \"solution-set\", assign_file = FALSE) #> Building hw00-soln files #> Creating a zip file for hw00-soln # Create only HTML documents for both assignment and solution files. assignr(hw00_file, \"test-html\", output_format = \"html_document\") #> Building hw00-assign files #> Creating a zip file for hw00-assign #> Building hw00-soln files #> Creating a zip file for hw00-soln # \\dontshow{ # Clean up generated directories unlink(\"test\", recursive = TRUE) unlink(\"assignment-set\", recursive = TRUE) unlink(\"solution-set\", recursive = TRUE) unlink(\"test-html\", recursive = TRUE) # }"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve example file path — get_example_filepath","title":"Retrieve example file path — get_example_filepath","text":"Obtains file path example Rmd package.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve example file path — get_example_filepath","text":"","code":"get_example_filepath(x)"},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve example file path — get_example_filepath","text":"x character containing name example Rmd.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve example file path — get_example_filepath","text":"File path example file ships package.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Retrieve example file path — get_example_filepath","text":"following example files ship package: hw00-main.Rmd","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/reference/get_example_filepath.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve example file path — get_example_filepath","text":"","code":"get_example_filepath(\"hw00-main.Rmd\") #> [1] \"/home/runner/work/_temp/Library/assignr/example_rmd/hw00-main.Rmd\""},{"path":[]},{"path":"https://r-pkg.thecoatlessprofessor.com/assignr/news/index.html","id":"features-0-0-1","dir":"Changelog","previous_headings":"","what":"Features","title":"assignr 0.0.1","text":"Automatically generate solution key assignment asingle .Rmd file via assignr(\"hwXX-main.Rmd\"). Compress individual solution key assignment files via zip. Automatically deploy GitHub Pages website default output directory set /docs.","code":""}]