Read a Data Package descriptor file (datapackage.json)

Reads information from a datapackage.json file, i.e. the descriptor file that describes the Data Package metadata and its Data Resources.

Usage

read_package(file = "datapackage.json")

Arguments

file

Path or URL to a datapackage.json file.

Value

List describing a Data Package. The function will add a custom property directory with the directory the descriptor was read from. It is used as a base path to access resources.

See also

Other read functions: read_resource(), resources()

Examples

# Read a datapackage.json file
package <- read_package(
  system.file("extdata", "datapackage.json", package = "frictionless")
)
#> Please make sure you have the right to access data from this Data Package for your intended use.
#> Follow applicable norms or requirements to credit the dataset and its authors.

# Access the Data Package properties
package$name
#> [1] "example_package"
package$created
#> [1] "2021-03-02T17:22:33Z"

# List resources
resources(package)
#> [1] "deployments"  "observations" "media"