Package: DataPackageR 0.16.2

Dave Slager

DataPackageR: Construct Reproducible Analytic Data Sets as R Packages

A framework to help construct R data packages in a reproducible manner. Potentially time consuming processing of raw data sets into analysis ready data sets is done in a reproducible manner and decoupled from the usual 'R CMD build' process so that data sets can be processed into R objects in the data package and the data package can then be shared, built, and installed by others without the need to repeat computationally costly data processing. The package maintains data provenance by turning the data processing scripts into package vignettes, as well as enforcing documentation and version checking of included data objects. Data packages can be version controlled on 'GitHub', and used to share data for manuscripts, collaboration and reproducible research.

Authors:Greg Finak [aut, cph], Paul Obrecht [ctb], Ellis Hughes [ctb], Jimmy Fulp [ctb], Marie Vendettuoli [ctb], Dave Slager [ctb, cre], Jason Taylor [ctb], Kara Woo [rev], William Landau [rev]

DataPackageR_0.16.2.tar.gz
DataPackageR_0.16.2.zip(r-4.7)DataPackageR_0.16.2.zip(r-4.6)DataPackageR_0.16.2.zip(r-4.5)
DataPackageR_0.16.2.tgz(r-4.6-any)DataPackageR_0.16.2.tgz(r-4.5-any)
DataPackageR_0.16.2.tar.gz(r-4.7-any)DataPackageR_0.16.2.tar.gz(r-4.6-any)
DataPackageR_0.16.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
DataPackageR/json (API)

# Install 'DataPackageR' in R:
install.packages('DataPackageR', repos = c('https://ropensci.r-universe.dev', 'https://cloud.r-project.org'))

Reviews:rOpenSci Software Review #230

Bug tracker:https://github.com/ropensci/datapackager/issues

Pkgdown/docs site:https://docs.ropensci.org

On CRAN:

Conda:

peer-reviewedreproducibility

8.69 score 155 stars 88 scripts 317 downloads 2 mentions 27 exports 58 dependencies

Last updated from:91c3001bcf (on main). Checks:5 OK, 5 ERROR. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK238
pkgdown docsOK179
source / vignettesOK183
linux-release-x86_64OK231
macos-release-arm64ERROR200
macos-oldrel-arm64ERROR208
windows-develERROR201
windows-releaseERROR199
windows-oldrelERROR238
wasm-releaseOK166

Exports:assert_data_versionconstruct_yml_configdata_versiondatapackage_skeletondatapackage.skeletondatapackager_object_readdataVersiondocumentkeepDataObjectspackage_buildproject_data_pathproject_extdata_pathproject_pathuse_data_objectuse_ignoreuse_processing_scriptuse_raw_datasetyml_add_filesyml_add_objectsyml_disable_compileyml_enable_compileyml_findyml_list_filesyml_list_objectsyml_remove_filesyml_remove_objectsyml_write

Dependencies:askpassbase64encbrewbslibcachemcallrclicliprcommonmarkcpp11crayoncredentialscurldescdigestevaluatefastmapfontawesomefsgertgitcredsgluehighrhtmltoolshttr2inijquerylibjsonliteknitrlifecyclemagrittrmemoisemimeopensslotelpkgbuildpkgloadprocessxpspurrrR6rappdirsrlangrmarkdownroxygen2rprojrootrstudioapisasssystinytexusethisvctrswhiskerwithrxfunxml2yamlzip

Using DataPackageR
Purpose | Set up a new data package. | What's in the package skeleton structure? | A note about the YAML config file. | Where do I put my raw datasets? | An API to read raw data sets from within an R or Rmd processing script. | YAML header metadata for R files and Rmd files. | Build the data package. | Documenting your data set changes in NEWS. | The build. | A note about the package source directory after building. | Update the auto-generated documentation. | Why not just use R CMD build? | Installing and using the new data package. | Accessing vignettes, data sets, and data set documentation. | Using the DataVersion. | Migrating old data packages. | Create a datapackager.yml file. | Reading data sets from Rmd files. | The old way. | The new way. | Partial builds. | Multi-script pipelines. | File system artifacts. | Passing data objects to subsequent scripts. | Next steps. | Place your package under source control. | Additional Details. | Fingerprints of stored data objects. | DATADIGEST | DESCRIPTION
Rendered fromUsing_DataPackageR.Rmdusingknitr::rmarkdown

Last update: 2024-10-14
Started: 2021-11-02

YAML Configuration Details
Configuring and controlling DataPackageR builds. | The datapackager.yml file. | YAML config file properties. | Editing the YAML config file. | YAML config API calls. | construct_yml_config | Example | yml_find | yml_list_objects | yml_list_files | yml_disable_compile | yml_enable_compile | yml_add_files | yml_add_objects | yml_remove_files | yml_remove_objects | yml_write
Rendered fromYAML_Configuration_Details.Rmdusingknitr::rmarkdown

Last update: 2024-04-27
Started: 2021-11-02