dataset_options: Set various options for dataset

In mah0001/nadar: NADA API Client for R

Set various options for dataset

Description

Set various options for dataset, such as access policy, project publish status, tags and aliases, owner and linked collections and links to the data, study website and indicators website.

Usage

dataset_options(
  idno,
  api_key = NULL,
  api_base_url = NULL,
  access_policy = NULL,
  data_remote_url = NULL,
  published = NULL,
  tags = NULL,
  aliases = NULL,
  owner_collection = NULL,
  linked_collections = NULL,
  link_study = NULL,
  link_indicator = NULL
)

Arguments

idno	(required) Study unique identifier
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)
access_policy	Select the access policy suitable for your data. Valid values - "direct", "public", "licensed", "data_enclave", "remote", "data_na", "open"
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
tags	Tag or vector of multiple tags for study (string)
aliases	Alias or vector of multiple aliases for study (string)
owner_collection	Collection that owns the dataset (repositoryid (string) of existing collection)
linked_collections	Display in other collections (repositoryid (string) of existing collection or vector with multiple collections)
link_study	URL for study website (string must include http:// or https://)
link_indicator	URL to the indicators website (string must include http:// or https://)
verbose	Show verbose output - True, False

Examples

dataset_options (
  idno="survey-idno-test",
  access_policy = "licensed",
  tags = "ihsn",
  link_study = "http://www.studypage.org",
  link_indicator = "http://www.indicatorpage.org"
)

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