timeseries_database_add: Create timeseries database

In mah0001/nadar: NADA API Client for R

Create timeseries database

Description

Create a new timeseries database

Usage

timeseries_database_add(
  idno,
  published = 0,
  overwrite = "no",
  metadata = NULL,
  api_key = NULL,
  api_base_url = NULL
)

Arguments

idno	(required) Study unique identifier
published	Set status for study - 0 = Draft, 1 = Published
overwrite	Overwrite if a study with the same ID already exists? Valid values "yes", "no"
metadata	(required) Metadata list

Examples

metadata=list(
"published"= 0,
"overwrite"= "no",
"database_description"= list(
  "title_statement"= list(
    "idno"= "string",
    "title"= "string",
    "sub_title"= "string",
    "alternate_title"= "string",
    "translated_title"= "string"
  ),
  "authoring_entity"= list(
    list(
      "name"= "string",
      "role"= "string",
      "affiliation"= "string",
      "abbreviation"= "string",
      "email"= "string"
    )
    ),
  "abstract"= "string",
  "url"= "string",
  "type"= "string",
  "doi"= "string",
  "date_created"= "string",
  "date_published"= "string",
  "version"= list(
    list(
      "version"= "string",
      "date"= "string",
      "responsibility"= "string",
      "notes"= "string"
    )
    ),
  "update_frequency"= "string",
  "update_schedule"= list(
    list(
      "update"= "string"
    )
    ),
  "time_coverage"= list(
    list(
      "start"= "string",
      "end"= "string"
    )
    ),
  "time_coverage_note"= "string",
  "periodicity"= list(
    list(
      "period"= "string"
    )
    ),
  "themes"= list(
    list(
      "name"= "string",
      "vocabulary"= "string",
      "uri"= "string"
    )
    ),
  "topics"= list(
    list(
      "id"= "string",
      "name"= "string",
      "parent_id"= "string",
      "vocabulary"= "string",
      "uri"= "string"
    )
    ),
  "keywords"= list(
    list(
      "name"= "string",
      "vocabulary"= "string",
      "uri"= "string"
    )
    ),
  "geographic_units"= list(
    list(
      "name"= "string",
      "code"= "string",
      "type"= "string"
    )
    ),
  "geographic_coverage_note"= "string",
  "bbox"= list(
    list(
      "west"= "string",
      "east"= "string",
      "south"= "string",
      "north"= "string"
    )
    ),
  "geographic_granularity"= "string",
  "geographic_area_count"= "string",
  "sponsors"= list(
    list(
      "name"= "string",
      "abbreviation"= "string",
      "role"= "string",
      "grant"= "string",
      "uri"= "string"
    )
    ),
  "acknowledgments"= list(
    list(
      "name"= "string",
      "affiliation"= "string",
      "role"= "string",
      "uri"= "string"
    )
    ),
  "contacts"= list(
    list(
      "name"= "string",
      "role"= "string",
      "affiliation"= "string",
      "email"= "string",
      "telephone"= "string",
      "uri"= "string"
    )
    ),
  "links"= list(
    list(
      "uri"= "string",
      "description"= "string"
    )
    ),
  "languages"= list(
    list(
      "name"= "string",
      "code"= "string"
    )
    ),
  "access_options"= list(
    list(
      "type"= "string",
      "uri"= "string",
      "note"= "string"
    )
    ),
  "license"= list(
    list(
      "type"= "string",
      "uri"= "string",
      "note"= "string"
    )
    ),
  "citation"= "string",
  "notes"= list(
    list(
      "note"= "string"
    )
    ),
  "disclaimer"= "string",
  "copyright"= "string"
),
"additional"= list()
)

timeseries_database_add (
  idno="document-idno",
  published = 1,
  overwrite = "yes",
  metadata = metadata
)

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