Build documentation for a data package using DataPackageR.

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

Arguments

path

character the path to the data package source root.

install

logical install and reload the package. (default TRUE)

...

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 = table(sample(1:10,100,replace=TRUE)) \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) }
#> Creating '/tmp/RtmpiNi3uS/file4e43bbe0b84/'
#> Setting active project to '/tmp/RtmpiNi3uS/file4e43bbe0b84'
#> Creating 'R/'
#> Writing 'DESCRIPTION'
#> Package: file4e43bbe0b84 #> Title: What the Package Does (One Line, Title Case) #> Version: 0.0.0.9000 #> [email protected] (parsed): #> * First Last <[email protected]> [aut, cre] (YOUR-ORCID-ID) #> Description: What the package does (one paragraph). #> License: `use_mit_license()`, `use_gpl3_license()` or friends to #> pick a license #> Encoding: UTF-8 #> LazyData: true #> Roxygen: list(markdown = TRUE) #> RoxygenNote: 7.1.1
#> Writing 'NAMESPACE'
#> Setting active project to '/tmp/RtmpiNi3uS/file4e457867644'
#> Setting active project to '/tmp/RtmpiNi3uS/file4e43bbe0b84'
#> Added DataVersion string to 'DESCRIPTION'
#> Creating 'data-raw/'
#> Creating 'data/'
#> Creating 'inst/extdata/'
#> Copied foo.Rmd into 'data-raw' #> configured 'datapackager.yml' file #> #> 1 data set(s) created by foo.Rmd #> tbl #> Built all datasets! #> Non-interactive NEWS.md file update. #>
#> Creating 'vignettes/'
#> Creating 'inst/doc/'
#> First time using roxygen2. Upgrading automatically...
#> Loading file4e43bbe0b84
#> Writing NAMESPACE #> Writing file4e43bbe0b84.Rd #> Writing tbl.Rd #> checking for file ‘/tmp/RtmpiNi3uS/file4e43bbe0b84/DESCRIPTION’ ... checking for file ‘/tmp/RtmpiNi3uS/file4e43bbe0b84/DESCRIPTION’ #> ─ preparing ‘file4e43bbe0b84’: #> checking DESCRIPTION meta-information ... checking DESCRIPTION meta-information #> ─ checking for LF line-endings in source and make files and shell scripts #> ─ checking for empty or unneeded directories #> NB: this package now depends on R (>= 3.5.0) #> WARNING: Added dependency on R >= 3.5.0 because serialized objects in serialize/load version 3 cannot be read in older versions of R. File(s) containing such objects: ‘file4e43bbe0b84/data/tbl.rda’ #> ─ building ‘file4e43bbe0b84_1.0.tar.gz’ #> #> Next Steps #> 1. Update your package documentation. #> - Edit the documentation.R file in the package source data-raw subdirectory and update the roxygen markup. #> - Rebuild the package documentation with document() . #> 2. Add your package to source control. #> - Call git init . in the package source root directory. #> - git add the package files. #> - git commit your new package. #> - Set up a github repository for your pacakge. #> - Add the github repository as a remote of your local package repository. #> - git push your local repository to gitub. #>
#> Updating file4e43bbe0b84 documentation
#> Loading file4e43bbe0b84
#> [1] TRUE