dvStudyStatement: Obtain a study statement

In ropensci/dvn: Access to Dataverse 3 APIs

Obtain a study statement

Description

Use Data Deposit API to obtain a listing of study contents.

Usage

dvStudyStatement(   objectid, dv=getOption('dvn'),
                    user=getOption('dvn.user'), pwd=getOption('dvn.pwd'),
                    browser=FALSE, ...)

Arguments

objectid	Either a character string containing the id for a dataverse study (a handle) or an object of class “dvStudyAtom”. This could be returned from dvUserStudies (or, dvSearch, from the Data Sharing API).
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.

Value

A list containing information about the study listing, including:

id	The Data Deposit API URI for the study.
title	The title of the study.
author	The study author.
updated	A timestamp.
locked	A logical as a character string.
latestVersionState	A character string containing, generally, “DRAFT” or “RELEASED”.
files	A dataframe containing of files stored in the study collection (and their associated fileId)
xml	A character string containing the original XML response data structure.

Author(s)

Thomas J. Leeper

See Also

dvUserStudies

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