Skip to contents

Create a Data Package

Source: R/create_package.R
create_package.Rd

Initiates a Data Package object, either from scratch or from an existing list. This Data Package object is a list with the following characteristics:

  • A datapackage subclass.

  • All properties of the original descriptor.

  • A resources property, set to an empty list if undefined.

  • A directory property, set to "." for the current directory if undefined. It is used as the base path to access resources with read_resource().

Usage

create_package(descriptor = NULL)

Arguments

descriptor

List to be made into a Data Package object. If undefined, an empty Data Package will be created from scratch.

Value

A Data Package object.

Details

See vignette("data-package") to learn how this function implements the Data Package standard. check_package() is automatically called on the created package to make sure it is valid.

See also

Other create functions: create_schema()

Examples

# Create a Data Package
package <- create_package()

package
#> A Data Package with 0 resources.
#> Use `unclass()` to print the Data Package as a list.

# See the structure of the (empty) Data Package
str(package)
#> List of 2
#>  $ resources: list()
#>  $ directory: chr "."
#>  - attr(*, "class")= chr [1:2] "datapackage" "list"