DataPackageR (version 0.16.2)

document: Build documentation for a data package using DataPackageR.

Description

Build documentation for a data package using DataPackageR.

Usage

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

Value

Called for side effects. Returns TRUE on successful exit.

Arguments

path

character the path to the data package source root.

install

logical install the package. (default FALSE)

...

additional arguments to install

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)
# \donttest{
# 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)
# }
}