Package 'rsf'

Git ignore generated outputs

Description

Add generated reports, figures, and HTML libraries to .gitignore

Usage

git_ignore_outputs(path = ".", figs_only = TRUE)

Arguments

path	path of the directory containing the input files .gitignore and ⁠_bookdown.yml⁠.
figs_only	logical; if TRUE (default), only figures are git ignored.

Examples

wd <- tempdir()
savedir <- setwd(wd)
file.copy(list.files(system.file("extdata", package = "rsf"),
                     full.names = TRUE, all.files = TRUE, no.. = TRUE), ".")
file.rename("gitignore", ".gitignore")
git_ignore_outputs(figs_only = FALSE)
setwd(savedir)

---

Use references

Description

Add a References section at the end of the RSF.

Usage

use_references(path = ".", number = 99)

Arguments

path	path of the directory containing the input files index.Rmd, ⁠_output.yml⁠, preamble.tex.
number	number prepended to references Rmd source file.

Examples

wd <- tempdir()
savedir <- setwd(wd)
file.copy(list.files(system.file("extdata", package = "rsf"),
                     full.names = TRUE), ".")
use_references(number = 4)
setwd(savedir)

---

Use RSF project template

Description

Opens a new R project using the RSF template. Intended for use in RStudio, not interactively.

Usage

use_rsf(path, ...)

Arguments

path	project path
...	project configurations supported: output_dir in ⁠_bookdown.yml⁠ https://bookdown.org/yihui/bookdown/configuration.html initialize git repo via gert::git_init() initialize renv via renv::init()

Details

This function is called when the user selects File > New Project > New Directory > Report of Statistical Findings using bookdown. The directory name and output directory can be specified.

---