use_data_object: Add a data object to a data package.

View source: R/use.R

use_data_objectR Documentation

Add a data object to a data package.

Description

The data object will be added to the yml configuration file.

Usage

use_data_object(object_name = NULL)

Arguments

object_name

Name of the data object. Should be created by a processing script in data-raw. character vector of length 1.

Value

invisibly returns TRUE for success.

Examples

if(rmarkdown::pandoc_available()){
myfile <- tempfile()
file <- system.file("extdata", "tests", "extra.rmd",
                     package = "DataPackageR")
datapackage_skeleton(
  name = "datatest",
  path = tempdir(),
  code_files = file,
  force = TRUE,
  r_object_names = "data")
use_data_object(object_name = "newobject")
}


RGLab/DataPackageR documentation built on April 19, 2024, 7:33 p.m.