Skip to content

omkarakatta/oakdown

Repository files navigation

oakdown

status

The goal of {oakdown} is to store and create single-document and multi-document templates that are so compatible that it is easy to switch between these templates.

Installation

You can install oakdown from github with:

install.packages("oakdown")

Example

Note

The note format puts the spotlight on a single Rmd file, making this ideal for note-taking. To begin, navigate to the directory where you want to store the note. Then, initialize the note as follows:

library(oakdown)
init_note("<name>")

This produces is an Rmd file called <name>.Rmd as well as a .gitignore if one does not already exist in that directory. Pay careful attention to the default YAML frontmatter provided in <name>.Rmd. For my convenience, I have included main.bib, econometrica.bst, and oaktex.sty as part of the frontmatter. These are stored on my local computer and have little to do with {oakdown}. Hence, change or remove these YAML parameters if you don’t have these files yourself.

After editing the contents of <name>.Rmd, you can render the Rmd file by calling:

render_note("<name>", config_file = "<config.yml>")

The bookdown configuration file, <config.yml>, must be in the same directory as the note. If <config.yml> does not exist in the directory, this function will generate a bookdown configuration file in the background that will be removed after the rendering is complete. To save the generated bookdown configuration file, specify save_config_file = TRUE as an argument to render_note().

About

Templates using R, LaTeX, and Pandoc

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published