Skip to contents

Get the DataVersion for a package

Source: R/dataversion.R
data_version.Rd

Retrieves the DataVersion of a package if available

Usage

data_version(pkg, lib.loc = NULL)

dataVersion(pkg, lib.loc = NULL)

Arguments

pkg

character the package name

lib.loc

character path to library location.

Value

Object of class 'package_version' and 'numeric_version' specifying the DataVersion of the package

Note

dataVersion() has been renamed to data_version()

See also

packageVersion

Examples

if(rmarkdown::pandoc_available()){
f <- tempdir()
f <- file.path(f,"foo.Rmd")
con <- file(f)
writeLines("```{r}\n vec = 1:10 \n```\n",con=con)
close(con)
pname <- basename(tempfile())
datapackage_skeleton(name = pname,
   path=tempdir(),
   force = TRUE,
   r_object_names = "vec",
   code_files = f)

   package_build(file.path(tempdir(),pname), install = FALSE)

   devtools::load_all(file.path(tempdir(),pname))
   data_version(pname)
}
#> ✔ Creating '/tmp/RtmpqmnlRG/file5b34bddf2e6/'
#> ✔ Setting active project to '/tmp/RtmpqmnlRG/file5b34bddf2e6'
#> ✔ Creating 'R/'
#> ✔ Writing 'DESCRIPTION'
#> Package: file5b34bddf2e6
#> Title: What the Package Does (One Line, Title Case)
#> Version: 0.0.0.9000
#> Authors@R (parsed):
#>     * First Last <first.last@example.com> [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
#> Roxygen: list(markdown = TRUE)
#> RoxygenNote: 7.3.1
#> ✔ Writing 'NAMESPACE'
#> ✔ Setting active project to '/tmp/RtmpqmnlRG/file5b39d43bd2'
#> ✔ Setting active project to '/tmp/RtmpqmnlRG/file5b34bddf2e6'
#> ✔ 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
#> • vec
#> ☘ Built  all datasets!
#> Non-interactive NEWS.md file update.
#> 
#> ✔ Creating 'vignettes/'
#> ✔ Creating 'inst/doc/'
#> ℹ Loading file5b34bddf2e6
#> Writing NAMESPACE
#> Writing file5b34bddf2e6.Rd
#> Writing vec.Rd
#> ── R CMD build ─────────────────────────────────────────────────────────────────
#> * checking for file ‘/tmp/RtmpqmnlRG/file5b34bddf2e6/DESCRIPTION’ ... OK
#> * preparing ‘file5b34bddf2e6’:
#> * checking DESCRIPTION meta-information ... OK
#> * checking for LF line-endings in source and make files and shell scripts
#> * checking for empty or unneeded directories
#> * looking to see if a ‘data/datalist’ file should be added
#> * building ‘file5b34bddf2e6_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. 
#> ℹ Loading file5b34bddf2e6
#> [1] ‘0.1.0’