Skip to content

Commit

Permalink
Address point 2 in #32
Browse files Browse the repository at this point in the history
- move YAML_CONFIG to vignettes.
Issue #24
- Add definition of data package to README.
Issue #25
- Move "R CMD build" to section after package_build is introduced.
- Extend the "Purpose" section a bit.
- Extended "Next Steps" and made it a sub-section.
- Referenced "Happy Git and Github for the useR" and Hadley's book on R packages.
- Fix typo mtcars2 to mtcars20
  • Loading branch information
gfinak committed Jul 9, 2018
1 parent ee6ee6c commit d6370fd
Show file tree
Hide file tree
Showing 12 changed files with 1,195 additions and 426 deletions.
2 changes: 0 additions & 2 deletions .Rbuildignore
Expand Up @@ -10,5 +10,3 @@ README.html
^appveyor\.yml$
NEWS.md
bibliography.bib
YAML_CONFIG.Rmd
YAML_CONFIG.md
2 changes: 1 addition & 1 deletion DESCRIPTION
Expand Up @@ -4,7 +4,7 @@ Title: Construct Reproducible Analytic Data Sets as R Packages
Authors@R:
c(person(given = "Greg Finak", role=c("aut","cre","cph"), email="gfinak@fredhutch.org"),
person(given = "Paul Obrecht", role=c("ctb")))
Version: 0.14.0
Version: 0.14.1
Description: Construct reproducible analytic data sets as R packages.
License: MIT + file LICENSE
Depends: R (>= 3.5.0)
Expand Down
4 changes: 3 additions & 1 deletion README.Rmd
Expand Up @@ -25,7 +25,7 @@ DataPackageR is used to reproducibly process raw data into packaged, analysis-re
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/RGLab/DataPackageR?branch=master&svg=true)](https://ci.appveyor.com/project/RGLab/DataPackageR)
[![DOI](https://zenodo.org/badge/29267435.svg)](https://doi.org/10.5281/zenodo.1292095)

- [yaml configuration guide](YAML_CONFIG.md)
- [yaml configuration guide](vignettes/YAML_CONFIG.md)


## What problems does DataPackageR tackle?
Expand All @@ -40,6 +40,8 @@ You have diverse raw data sets that you need to preprocess and tidy in order to:

### Why package data sets?

**Definition:** A *data package* is a formal R package whose sole purpose is to contain, access, and / or document data sets.

- **Reproducibility.**

As described [elsewhere](https://github.com/ropensci/rrrpkg), packaging your data promotes reproducibility.
Expand Down
13 changes: 8 additions & 5 deletions README.md
Expand Up @@ -14,7 +14,7 @@ status](https://codecov.io/gh/RGLab/DataPackageR/branch/master/graph/badge.svg)]
status](https://ci.appveyor.com/api/projects/status/github/RGLab/DataPackageR?branch=master&svg=true)](https://ci.appveyor.com/project/RGLab/DataPackageR)
[![DOI](https://zenodo.org/badge/29267435.svg)](https://doi.org/10.5281/zenodo.1292095)

- [yaml configuration guide](YAML_CONFIG.md)
- [yaml configuration guide](vignettes/YAML_CONFIG.md)

## What problems does DataPackageR tackle?

Expand All @@ -30,6 +30,9 @@ order to:

### Why package data sets?

**Definition:** A *data package* is a formal R package whose sole
purpose is to contain, access, and / or document data sets.

- **Reproducibility.**

As described [elsewhere](https://github.com/ropensci/rrrpkg),
Expand Down Expand Up @@ -198,7 +201,7 @@ DataPackageR::datapackage_skeleton(
#> Saving functions and data ...
#> Making help files ...
#> Done.
#> Further steps are described in '/var/folders/jh/x0h3v3pd4dd497g3gtzsm8500000gn/T//Rtmpwy0gLc/mtcars20/Read-and-delete-me'.
#> Further steps are described in '/var/folders/jh/x0h3v3pd4dd497g3gtzsm8500000gn/T//RtmpNPoc2o/mtcars20/Read-and-delete-me'.
#> Adding DataVersion string to DESCRIPTION
#> Creating data and data-raw directories
#> configuring yaml file
Expand All @@ -211,12 +214,12 @@ DataPackageR:::package_build(file.path(tempdir(),"mtcars20"))
#> processing file: subsetCars.Rmd
#> output file: subsetCars.knit.md
#>
#> Output created: /private/var/folders/jh/x0h3v3pd4dd497g3gtzsm8500000gn/T/Rtmpwy0gLc/mtcars20/inst/extdata/Logfiles/subsetCars.html
#> Output created: /private/var/folders/jh/x0h3v3pd4dd497g3gtzsm8500000gn/T/RtmpNPoc2o/mtcars20/inst/extdata/Logfiles/subsetCars.html
#> First time using roxygen2. Upgrading automatically...
#> Updating roxygen version in /private/var/folders/jh/x0h3v3pd4dd497g3gtzsm8500000gn/T/Rtmpwy0gLc/mtcars20/DESCRIPTION
#> Updating roxygen version in /private/var/folders/jh/x0h3v3pd4dd497g3gtzsm8500000gn/T/RtmpNPoc2o/mtcars20/DESCRIPTION
#> '/Library/Frameworks/R.framework/Resources/bin/R' --no-site-file \
#> --no-environ --no-save --no-restore --quiet CMD build \
#> '/private/var/folders/jh/x0h3v3pd4dd497g3gtzsm8500000gn/T/Rtmpwy0gLc/mtcars20' \
#> '/private/var/folders/jh/x0h3v3pd4dd497g3gtzsm8500000gn/T/RtmpNPoc2o/mtcars20' \
#> --no-resave-data --no-manual --no-build-vignettes
#>

Expand Down

0 comments on commit d6370fd

Please sign in to comment.