script_add: Create new script

In mah0001/nadar: NADA API Client for R

Create new script

Description

Create a new script

Usage

script_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 using the Script Schema
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

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

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