| Title: | An updated R Markdown thesis template for Oregon State University using the bookdown package |
|---|---|
| Description: | Using the bookdown package and LaTeX and Word thesis templates from Oregon State University, this package was derived from Chester Ismay's package "thesisdown" |
| Authors: | Zhian N. Kamvar [aut, cre], Chester Ismay [aut, ccp], Rick Treinen [aut], Neville Mehta [aut], Deling Ren [aut], John Metta [aut, ccp] |
| Maintainer: | Zhian N. Kamvar <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.2.1 |
| Built: | 2024-08-28 03:04:24 UTC |
| Source: | https://github.com/zkamvar/beaverdown |
This package creates theses/dissertations for Oregon State University.
Creates an R Markdown thesis template as a webpage
Creates an R Markdown thesis template as a PDF
Creates an R Markdown thesis template as a Microsoft Word document
Return latex control text if rendering latex
iflatex(txt)iflatex(txt)
txt |
a string
## Not run: iflatex("\\vspace*{\\fill}") ## End(Not run)## Not run: iflatex("\\vspace*{\\fill}") ## End(Not run)
Generate a section for the yaml input
inc(input, sep = "\n ")inc(input, sep = "\n ")
input |
a file containing markdown text |
sep |
a separator for each line. Defaults to "\n " |
a string
f <- file() cat(" this is\nsome text that\nwill be renedered in\na file\n", file = f) cat(inc(f)) close(f)f <- file() cat(" this is\nsome text that\nwill be renedered in\na file\n", file = f) cat(inc(f)) close(f)
Process citations in a text formatted with markdown
process_citations(caption, yml, figname = "fig1", to = "latex")process_citations(caption, yml, figname = "fig1", to = "latex")
caption |
text formatted with markdown |
yml |
a list of yaml metadata |
figname |
the name of the output file |
to |
the output format. Defaults to "latex". Could also be "html". "markdown" does nothing useful. |
formatted text with rendered citations
# Setup for the example # Note that this will already be set for you when you run the document rootdir <- find.package("beaverdown") rootdir <- paste0(rootdir, "/rmarkdown/templates/oregonstate/skeleton/") bib <- file.path(rootdir, c("bib/references.bib", "bib/thesis.bib")) bib <- paste(bib, collapse = "\n ") csl <- file.path(rootdir, "csl/apa.csl") txt <- "**Hey!** This is a citation from @angel2000." yml <- list(bibliography = bib, csl = csl, `link-citations` = TRUE) process_citations(txt, yml)# Setup for the example # Note that this will already be set for you when you run the document rootdir <- find.package("beaverdown") rootdir <- paste0(rootdir, "/rmarkdown/templates/oregonstate/skeleton/") bib <- file.path(rootdir, c("bib/references.bib", "bib/thesis.bib")) bib <- paste(bib, collapse = "\n ") csl <- file.path(rootdir, "csl/apa.csl") txt <- "**Hey!** This is a citation from @angel2000." yml <- list(bibliography = bib, csl = csl, `link-citations` = TRUE) process_citations(txt, yml)
Captions are not rendered to latex by default. To aid in writing these, This function will take in your markdown-formatted caption, and give you a latex formatted caption.
render_caption(caption, figname = "fig1", index = "index.Rmd", to = "latex")render_caption(caption, figname = "fig1", index = "index.Rmd", to = "latex")
caption |
the markdown-formatted text you want to render as a figure caption. |
figname |
the name of the figure (as to not crowd the ) |
This works by utilizing the knitr function
pandoc. It allows you to include references in your
captions, which are not automatically rendered.
a figure caption rendered in LaTeX
# Setup for the example # Note that this will already be set for you when you run the document rootdir <- find.package("beaverdown") rootdir <- paste0(rootdir, "/rmarkdown/templates/oregonstate/skeleton/") knitr::opts_knit$set(root.dir = rootdir) caption <- "This is some *text* to use as a caption [@angel2000]!" # Make sure to set your index to whatever your project is called! render_caption(caption, index = "skeleton.Rmd")# Setup for the example # Note that this will already be set for you when you run the document rootdir <- find.package("beaverdown") rootdir <- paste0(rootdir, "/rmarkdown/templates/oregonstate/skeleton/") knitr::opts_knit$set(root.dir = rootdir) caption <- "This is some *text* to use as a caption [@angel2000]!" # Make sure to set your index to whatever your project is called! render_caption(caption, index = "skeleton.Rmd")
This is a function called in output in the YAML of the driver Rmd file to specify the creation of a epub version of the thesis.
thesis_epub()thesis_epub()
A ebook version of the thesis
## Not run: output: thesisdown::thesis_epub ## End(Not run)## Not run: output: thesisdown::thesis_epub ## End(Not run)
This is a function called in output in the YAML of the driver Rmd file to specify the creation of a webpage version of the thesis.
thesis_gitbook()thesis_gitbook()
A gitbook webpage
## Not run: output: thesisdown::thesis_gitbook ## End(Not run)## Not run: output: thesisdown::thesis_gitbook ## End(Not run)
This is a function called in output in the YAML of the driver Rmd file to specify using the Oregon State University LaTeX template and cls files.
thesis_pdf(toc = TRUE, toc_depth = 3, ...)thesis_pdf(toc = TRUE, toc_depth = 3, ...)
toc |
A Boolean (TRUE or FALSE) specifying where table of contents should be created |
toc_depth |
A positive integer |
... |
arguments to be passed to |
A modified pdf_document based on the Reed Senior Thesis LaTeX
template
The arguments highlight, keep_tex, and pandoc_args, are already set.
## Not run: output: thesisdown::thesis_pdf ## End(Not run)## Not run: output: thesisdown::thesis_pdf ## End(Not run)
This is a function called in output in the YAML of the driver Rmd file to specify the creation of a Microsoft Word version of the thesis.
thesis_word()thesis_word()
A Word Document based on (hopefully soon, but not currently) the Reed Senior Thesis Word template
## Not run: output: thesisdown::thesis_word ## End(Not run)## Not run: output: thesisdown::thesis_word ## End(Not run)