dvUserStudies: Studies in a Dataverse

In ropensci/dvn: Access to Dataverse 3 APIs

Studies in a Dataverse

Description

Use Data Deposit API to obtain list of studies in a named Dataverse.

Usage

dvUserStudies(  dvname, dv=getOption('dvn'), user=getOption('dvn.user'),
                pwd=getOption('dvn.pwd'), browser=FALSE, ...)

Arguments

dvname	A character string containing the name of a dataverse collection. Must be a dataverse accessible to this user (perhaps as returned by dvServiceDoc.
dv	An optional character string specifying the Dataverse to query. Default is the Harvard IQSS Dataverse.
user	A character string containing a dataverse username. Default is options('dvn.user').
pwd	A character string containing the corresponding dataverse password. Default is options('dvn.pwd').
browser	A logical specifying whether the query should be executed in a web browser. Default is FALSE.
...	Optionally, additional arguments passed to getURL via dvDepositQuery.

Details

For the dvname argument, it is also possible to simply pass the “dvServiceDoc” object directly in lieu of naming a dataverse: dvUserStudies(dvServiceDoc()). If the user has access to more than one dataverse collection, the first will be used (and produce a warning).

Value

A list containing:

dvtitle	The title of the dataverse, as a character string.
released	A character string reporting whether the dataverse is publicly released.
generator	A vector containing details about the SWORD application.
studies	A two-column dataframe containing title and objectId for each study in the dataverse.
xml	A character string containing an XML data structure, which describes the studies available in a named dataverse.

Author(s)

Thomas J. Leeper

See Also

dvStudyStatement dvStudyAtom

ropensci/dvn documentation built on May 18, 2022, 9:52 a.m.