read_package: Read a Data Package descriptor file ('datapackage.json')

View source: R/read_package.R

read_packageR Documentation

Read a Data Package descriptor file (datapackage.json)

Description

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.

Details

See vignette("data-package") to learn how this function implements the Data Package standard.

Value

A Data Package object, see create_package().

See Also

Other read functions: read_resource(), resources()

Examples

# Read a datapackage.json file
package <- read_package(
  system.file("extdata", "v1", "datapackage.json", package = "frictionless")
)

package

# Access the Data Package properties
package$name
package$created

frictionlessdata/frictionless-r documentation built on April 17, 2025, 11:45 a.m.