document: Build documentation for a data package using DataPackageR.

In DataPackageR: Construct Reproducible Analytic Data Sets as R Packages

Build documentation for a data package using DataPackageR.

Description

Build documentation for a data package using DataPackageR.

Usage

document(path = ".", install = FALSE, ...)

Arguments

path	character the path to the data package source root.
install	logical install the package. (default FALSE)
...	additional arguments to install

Value

Called for side effects. Returns TRUE on successful exit.

Examples

# A simple Rmd file that creates one data object
# named "tbl".
if(rmarkdown::pandoc_available()){
f <- tempdir()
f <- file.path(f,"foo.Rmd")
con <- file(f)
writeLines("```{r}\n tbl = data.frame(1:10) \n```\n",con=con)
close(con)

# construct a data package skeleton named "MyDataPackage" and pass
# in the Rmd file name with full path, and the name of the object(s) it
# creates.

pname <- basename(tempfile())
datapackage_skeleton(name=pname,
   path=tempdir(),
   force = TRUE,
   r_object_names = "tbl",
   code_files = f)

# call package_build to run the "foo.Rmd" processing and
# build a data package.
package_build(file.path(tempdir(), pname), install = FALSE)
document(path = file.path(tempdir(), pname), install = FALSE)

}

DataPackageR documentation built on Sept. 18, 2024, 1:07 a.m.