r-lib / Ymlthis
Licence: other
write YAML for R Markdown, bookdown, blogdown, and more
Stars: ✭ 132
Programming Languages
r
7636 projects
ymlthis: write YAML for R Markdown, bookdown, blogdown, and more
ymlthis makes it easy to write YAML front matter for R Markdown and
related documents. yml_*()
functions write functions and use_*()
functions let you write the resulting YAML to your clipboard or to
.yml
files related to your project.
Installation
You can install ymlthis from CRAN with:
install.packages("ymlthis")
Or you can install the development version of ymlthis from GitHub with:
# install.packages("remotes")
remotes::install_github("r-lib/ymlthis")
Example
yml()
creates a basic yml
object returns simple YAML with the author
and date.
library(ymlthis)
yml()
#> ---
#> author: Malcolm Barrett
#> date: '`r format(Sys.Date())`'
#> ---
ymlthis supports many YAML arguments, with YAML-generating functions
prefixed with yml_*()
:
yml() %>%
yml_author(c("Yihui Xie", "Hadley Wickham"), affiliation = "RStudio") %>%
yml_date(lubridate::today()) %>%
yml_output(
pdf_document(keep_tex = TRUE, includes = includes2(after_body = "footer.tex")),
bookdown::html_document2()
) %>%
yml_latex_opts(biblio_style = "apalike")
#> ---
#> author:
#> - name: Yihui Xie
#> affiliation: RStudio
#> - name: Hadley Wickham
#> affiliation: RStudio
#> date: '2019-10-10'
#> output:
#> pdf_document:
#> keep_tex: true
#> includes:
#> after_body: footer.tex
#> bookdown::html_document2: default
#> biblio-style: apalike
#> ---
Add-in
ymlthis also includes an add-in that will create YAML for you and put it
in a file, such as an .Rmd
file, or on your clipboard.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].