get_package: Get a structured list of PIDs for the objects in a package

View source: R/util.R

get_packageR Documentation

Get a structured list of PIDs for the objects in a package

Description

\Sexpr[results=rd, stage=render]{lifecycle::badge("deprecated")}

Usage

get_package(node, pid, file_names = FALSE, rows = 5000)

Arguments

node

(MNode/CNode) The Coordinating/Member Node to run the query on.

pid

(character) The the resource map PID of the package.

file_names

(logical) Whether to return file names for all objects.

rows

(numeric) The number of rows to return in the query. This is only useful to set if you are warned about the result set being truncated. Defaults to 5000.

Details

Please use dataone::getDataPackage() when possible

Get a structured list of PIDs for the objects in a package, including the resource map, metadata, and data objects.

Value

(list) A structured list of the members of the package.

Examples

## Not run: 
#Set environment
cn <- CNode("STAGING2")
mn <- getMNode(cn,"urn:node:mnTestKNB")
pid <- "resource_map_urn:uuid:3e5307c4-0bf3-4fd3-939c-112d4d11e8a1"

ids <- get_package(mn, pid)

## End(Not run)

NCEAS/arcticdatautils documentation built on Aug. 28, 2023, 12:10 p.m.