mdl_survey_attach_to_collections: Attach studies to collections

In UNHCRmdl/mdl: R client for UNHCR Microdata Library

Attach studies to collections

Description

Used to modify the main collection and/or add the secondary collections. In case you only want to change the main collection it is recommended to use mdl_survey_options(), or you can try to set link_collections to the same value of enum_collection.

Usage

mdl_survey_attach_to_collections(
  survey_idno,
  enum_collection = NULL,
  link_collections,
  mode = "update"
)

Arguments

survey_idno	Dataset IDNo.
enum_collection	Main collection of the dataset (optional). It is recommended to use mdl_enum_collection.
link_collections	Array containing other secondary collections in which the dataset has to be shown (required). It is recommended to use mdl_enum_collection.
mode	Select flag to update or replace existing linked collections for the study: "replace" = replace linked collections for the study with the provided list; "update" = (Default) add/update linked collections list.

Value

API call response.

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