prepareTemplate: Prepare R Markdown template

Description Usage Arguments Details Value Note Examples

View source: R/prepareTemplate.R

Description

If the required template dependency files aren't present, copy them from the requested package. Existing files are not overwritten by default. This function will copy dependency files from a requested package inside the rmarkdown/shared/ directory. If a package doesn't contain this subdirectory, the function will return an error.

Usage

1
prepareTemplate(package = NULL, overwrite = FALSE)

Arguments

package

character(1) or NULL. Name of package containing the R Markdown template. If NULL, only the basic shared files defined in the basejump package will be copied.

overwrite

logical(1). Should existing destination files be overwritten?

Details

This code is used internally by:

Value

Invisible logical. Was the file copied?.

Note

Updated 2019-11-19.

Examples

1
2
3
4
5
## RNA-seq template.
## > prepareTemplate(package = "bcbioRNASeq")

## Single-cell RNA-seq template.
## > prepareTemplate(package = "bcbioSingleCell")

acidgenomics/basejump documentation built on Nov. 21, 2019, 1:36 a.m.