get_refs_info: Return Basic information about a list of DataStore References

In nationalparkservice/DSTools: Collection of Functions to read and manipulate information from the NPS DataStore

Return Basic information about a list of DataStore References

Description

The function will return a data frame containing information about a given number of references within a reference type. The data returned includes the reference ID (referenceId), the date the references was activated on DataStore (dateOfIssue), the references visibility (visibility), the number of files associated with the reference (fileCount), the access level of the files (fileAccess), the reference title (title), the abbreviated citation (citation), the URL for the DataStore reference (referenceUrl), the group-type for the reference (referenceGroupType), the type of reference (typeName), whether the reference has a DOI associated with it (isDOI), whether their is a newer version of the reference (newVersion) and what the most recent version of the reference is (mostRecentReference).

Usage

get_refs_info(
  reference_type = "dataPackage",
  no_of_entries = 500,
  secure = FALSE
)

Arguments

reference_type	String. The reference type to to query data store for. Defaults to data package ("dataPackage").
no_of_entries	Integer. The number of entries to return per page (where only one "page" of results is returned by default). Defaults to 500.
secure	Logical. Defaults to FALSE for external users. Setting secure = TRUE will, with the proper credentials, return DataStore references with visibility set to both Public and Restricted.

Value

a data frame

Examples

## Not run: 
get_ref_info()

## End(Not run)

nationalparkservice/DSTools documentation built on March 29, 2025, 10:54 p.m.