create: Create new study

In mah0001/nadar: NADA API Client for R

Create new study

Description

Create a new study

Usage

create(
  type,
  idno,
  metadata,
  repositoryid = NULL,
  access_policy = NULL,
  data_remote_url = NULL,
  published = NULL,
  overwrite = NULL,
  thumbnail = NULL,
  api_key = NULL,
  api_base_url = NULL
)

Arguments

type	(required) Type of study - survey, geospatial, table, document, timeseries
idno	(required) Study unique identifier
metadata	(required) Metadata list depending on the type of study
repositoryid	Collection ID that owns the study
access_policy	Select the access policy suitable for your data. Valid values - "open" "direct" "public" "licensed" "enclave" "remote" "other"
data_remote_url	Link to the website where the data is available. Required if access_policy is set to 'remote'.
published	Set status for study - 0 = Draft, 1 = Published
overwrite	Overwrite if a study with the same ID already exists? Valid values "yes", "no"
api_key	API key (optional if API key is set using set_api_key)
api_base_url	API base endpoint (optional if API base endpoint is set using set_api_url)

Examples

metadata=list(
doc_desc=list(
"idno"="doc-idno",
"producers"=list(
list(
    "name"="name here",
    "abbr"="abbreviation"
  )
)
),

study_desc=list(
  "title_statement"= list(
    "idno"= "survey-idno-test",
    "title"= "string",
    "sub_title"= "string",
    "alternate_title"= "string",
    "translated_title"= "string"
  ),
  "study_info"=list(
    "nation"=list(
      list(
        "name"="Test",
        "abbreviation"="tst")
    )
  )
)
)

create (
  idno="survey-idno-test",
  type="survey",
  published = 1,
  overwrite = "yes",
  metadata = metadata,
  additional = NULL
)

mah0001/nadar documentation built on March 30, 2024, 2:44 a.m.