| Type: | Package |
| Title: | Report of Statistical Findings in 'bookdown' |
| Version: | 0.3.0 |
| Description: | A report of statistical findings (RSF) project template is generated using a 'bookdown' format. 'YAML' fields can be further customized. Additional helper functions provide extra features to the RSF. |
| License: | MIT + file LICENSE |
| URL: | https://github.com/dchiu911/rsf/, https://dchiu911.github.io/rsf/ |
| BugReports: | https://github.com/dchiu911/rsf/issues |
| Imports: | bookdown, gert, here, knitr, magrittr, renv, rlang, usethis, yaml, ymlthis |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.2.1 |
| NeedsCompilation: | no |
| Packaged: | 2022-09-15 17:36:49 UTC; derekchiu |
| Author: | Derek Chiu [aut, cre] |
| Maintainer: | Derek Chiu <dchiu@bccrc.ca> |
| Repository: | CRAN |
| Date/Publication: | 2022-09-15 19:26:09 UTC |
rsf: Report of Statistical Findings in 'bookdown'
Description
A report of statistical findings (RSF) project template is generated using a 'bookdown' format. 'YAML' fields can be further customized. Additional helper functions provide extra features to the RSF.
Author(s)
Maintainer: Derek Chiu dchiu@bccrc.ca
See Also
Useful links:
Report bugs at https://github.com/dchiu911/rsf/issues
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 |
figs_only |
logical; if |
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 |
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:
|
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.