mdl_survey_options: Set survey options

View source: R/survey.R

mdl_survey_optionsR Documentation

Set survey options

Description

Can set various survey options with a PUT call. If you want to set linked/secondary collections, it is recommended to use mdl_survey_attach_to_collections().

Usage

mdl_survey_options(
  survey_idno,
  enum_survey_access_policy = NULL,
  data_remote_url = NULL,
  published = NULL,
  enum_collection = NULL,
  linked_collections = NULL,
  tags = NULL,
  aliases = NULL,
  link_study = NULL,
  link_indicator = NULL
)

Arguments

survey_idno

Dataset IDNo.

enum_survey_access_policy

Access policy. It is recommended to use mdl_enum_survey_access_policy.

data_remote_url

Url to data in case access policiy was set to Data available from external repository ("remote")

published

Set Dataset publish status. 0=draft, 1=published.

enum_collection

Main collection of the dataset. It is recommended to use mdl_enum_collection.

linked_collections

Array containing other secondary collections in which the dataset has to be shown.

tags

Array of string tags.

aliases

Array of strings with dataset aliases

link_study

URL for study website

link_indicator

URL to the indicators website

Value

API call response.


UNHCRmdl/mdl documentation built on Jan. 15, 2025, 6:40 p.m.