util_spin: Spin 'R' Scripts into 'R' Markdown Files

Description Usage Arguments Author(s) Examples

View source: R/util_spin.R

Description

Spin R Scripts into R Markdown Files

Usage

1
2
3
4
5
6
7
8
9
util_spin(
  dir = getwd(),
  recursive = FALSE,
  files = NULL,
  knit = FALSE,
  par = TRUE,
  ncores = NULL,
  ...
)

Arguments

dir

Character string. Directory which contains target files. Ignored if file is NOT NULL.

recursive

Logical. If TRUE, recursively spin all R scripts (.R, .r) in dir. Ignored if file is NOT NULL.

files

Character vector. Vector of files to spin.

knit

Logical. If TRUE, compiles the document after conversion.

par

Logical. If TRUE, use multiple cores.

ncores

Integer. Number of cores to use if par = TRUE. If unspecified, defaults to detectCores() - 1.

...

Arguments to pass to knitr::spin().

Author(s)

Ivan Jacob Agaloos Pesigan

Examples

1
2
3
4
5
6
7
## Not run: 
util_spin(
  dir = getwd(),
  par = FALSE
)

## End(Not run)

jeksterslabds/jeksterslabRutils documentation built on Jan. 18, 2021, 11:41 p.m.