document_add: Create new document

In mah0001/nadar: NADA API Client for R

Create new document

Description

Create a new document

Usage

document_add(
  idno,
  metadata,
  repositoryid = NULL,
  access_policy = NULL,
  data_remote_url = NULL,
  published = 0,
  overwrite = "no",
  thumbnail = NULL,
  api_key = NULL,
  api_base_url = NULL
)

Arguments

idno	(required) Study unique identifier
metadata	(required) Metadata list
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"

Examples

metadata=list(
"repositoryid"= NULL,
"published"= 1,
"overwrite"= "no",
"metadata_information"= list(
"title"= "string",
"idno"= "string",
"producers"= list(
 list(
      "name"= "string",
      "abbr"= "string",
      "affiliation"= "string",
      "role"= "string"
    )
  ),
  "production_date"= "string",
  "version"= "string"
),
"document_description"= list(
  "title_statement"= list(
    "idno"= "document-unique-id",
    "title"= "document title",
    "sub_title"= "string",
    "alternate_title"= "string",
    "abbreviated_title"= "string"
  ),
  "type"= "article",
  "description"= "string",
  "toc"= "string",
  "toc_structured"= list(
    list(
      "id"= "string",
      "parent_id"= "string",
      "name"= "string"
    )
  ),
  "abstract"= "string",
  "notes"= list(
    list(
      "note"= "string"
    )
  ),
  "scope"= "string",
  "ref_country"= list(
    list(
      "name"= "country name",
      "code"= "string"
    ),
    list(
      "name"= "country name 2",
      "code"= "string"
    )
  ),
  "spatial_coverage"= "string",
  "temporal_coverage"= "string",
  "date_created"= "string",
  "date_available"= "string",
  "date_modified"= "string",
  "date_published"= "string",
  "id_numbers"= list(
    "type"= "string",
    "value"= "string"
  ),
  "publication_frequency"= "string",
  "languages"= list(
    list(
      "name"= "string",
      "code"= "string"
    )
  ),
  "license"= list(
    list(
      "name"= "string",
      "uri"= "string"
    )
),
  "bibliographic_citation"= "string",
  "chapter"= "string",
  "edition"= "string",
  "institution"= "string",
  "journal"= "string",
  "volume"= "string",
  "issue"= "string",
  "pages"= "string",
  "series"= "string",
  "creator"= "string",
  "authors"= list(
    list(
      "first_name"= "string",
      "initial"= "string",
      "last_name"= "string",
      "affiliation"= "string"
    )
  ),
  "editors"= list(
    list(
      "first_name"= "string",
      "initial"= "string",
      "last_name"= "string",
      "affiliation"= "string"
    )
  ),
  "translators"= list(
    list(
      "first_name"= "string",
      "initial"= "string",
      "last_name"= "string",
      "affiliation"= "string"
    )
  ),
  "contributors"= list(
    list(
      "first_name"= "string",
      "initial"= "string",
      "last_name"= "string",
      "affiliation"= "string"
    )
  ),
  "publisher"= "string",
  "publisher_address"= "string",
  "rights"= "string",
  "copyright"= "string",
  "usage_terms"= "string",
  "security_classification"= "string",
  "access_restrictions"= "string",
  "sources"= list(
    "data_source"= list(),
    "source_origin"= "string",
    "source_char"= "string",
    "source_doc"= "string"
  ),
  "keywords"= list(
    list(
      "name"= "string",
      "vocabulary"= "string",
      "uri"= "string"
    )
  ),
  "themes"= list(
    list(
      "name"= "string",
      "vocabulary"= "string",
      "uri"= "string"
    )
  ),
  "topics"= list(
    list(
      "id"= "string",
      "name"= "string",
      "parent_id"= "string",
      "vocabulary"= "string",
      "uri"= "string"
    )
  ),
  "disciplines"= list(
    list(
      "name"= "string",
      "vocabulary"= "string",
      "uri"= "string"
    )
  ),
  "audience"= "string",
  "mandate"= "string",
  "pricing"= "string",
  "relations"= list(
    list(
      "name"= "string",
      "type"= "isPartOf"
    )
  ),
  "lda_topics"= list(
    list(
      "model_info"= list(
        list(
          "source"= "string",
          "author"= "string",
          "version"= "string",
          "model_id"= "string",
          "nb_topics"= 0,
          "description"= "string",
          "corpus"= "string",
          "uri"= "string"
        )
      ),
      "topic_description"= list(
        list(
          "topic_id"= 1,
          "topic_score"= .01,
          "topic_label"= "label",
          "topic_words"= list(
            list(
              "word"= "string"
            )
          )
        )
      )
    )
  )
),
"tags"= list(
  list(
    "tag"= "string"
  )
),
"files"= list(
  list(
    "file_uri"= "string",
    "format"= "string",
    "location"= "string",
    "note"= "string"
  )
)
)

document_add(
  idno="document-idno",
  published = 1,
  overwrite = "yes",
  metadata = metadata,
  thumbnail ="images/thumbnail.jpg"
)

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