From c2041111ec11a1318ecf70baafce048c736cc8bd Mon Sep 17 00:00:00 2001 From: Bryce Mecum Date: Wed, 14 Sep 2016 14:07:32 -0800 Subject: [PATCH] v0.5.0 --- DESCRIPTION | 2 +- man/get_package.Rd | 12 +++++++----- man/get_package_direct.Rd | 25 +++++++++++++++++++++++++ 3 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 man/get_package_direct.Rd diff --git a/DESCRIPTION b/DESCRIPTION index c51b52b..39679dd 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: arcticdatautils Title: Arctic Data Utilities -Version: 0.4.1 +Version: 0.5.0 Authors@R: c( person("Bryce", "Mecum", email = "mecum@nceas.ucsb.edu", role = c("aut", "cre")), person("Matt", "Jones", email = "jones@nceas.ucsb.edu", role = "ctb") diff --git a/man/get_package.Rd b/man/get_package.Rd index 9322dec..b55e5e8 100644 --- a/man/get_package.Rd +++ b/man/get_package.Rd @@ -4,21 +4,23 @@ \alias{get_package} \title{Get a structured list of PIDs for the objects in a package.} \usage{ -get_package(mn, pid, parent = FALSE, rows = 1000) +get_package(mn, pid, file_names = FALSE, rows = 1000) } \arguments{ \item{mn}{(MNode) The Member Node to run the query on.} \item{pid}{(character) The the metadata PID of the package.} -\item{parent}{(logical) Whether to query for the parent package. Setting this -to true will make this function take longer to run so it is turned of by -default.} +\item{file_names}{(logical) Whether to return file names for all objects.} + +\item{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.} } \value{ (list) A structured list of the members of the package. } \description{ -Get a structured list of PIDs for the objects in a package. +This is a wrapper function around `get_package_direct` which takes either +a resource map PID or a metadata PID as its `pid` argument. } diff --git a/man/get_package_direct.Rd b/man/get_package_direct.Rd new file mode 100644 index 0000000..0ab1e9a --- /dev/null +++ b/man/get_package_direct.Rd @@ -0,0 +1,25 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/util.R +\name{get_package_direct} +\alias{get_package_direct} +\title{Get a structured list of PIDs for the objects in a package.} +\usage{ +get_package_direct(mn, pid, file_names = FALSE, rows = 1000) +} +\arguments{ +\item{mn}{(MNode) The Member Node to run the query on.} + +\item{pid}{(character) The the metadata PID of the package.} + +\item{file_names}{(logical) Whether to return file names for all objects.} + +\item{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.} +} +\value{ + +} +\description{ +Get a structured list of PIDs for the objects in a package. +} +