microdata_add | R Documentation |
Create a new Microdata study
microdata_add(
idno,
repositoryid = "central",
access_policy = NULL,
data_remote_url = NULL,
published = 1,
overwrite = "no",
metadata = NULL,
thumbnail = NULL,
api_key = NULL,
api_base_url = NULL
)
idno |
(required) Survey unique identifier |
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" |
type |
(required) DDI/XML file path |
doc_desc |
Document description |
study_desc |
(Required) Study description |
data_files |
Data files |
variables |
List of variables and metadata |
variable_groups |
List of variable groups |
additional |
Additional metadata |
metadata=list(
doc_desc=list(
"idno"="doc-idno",
"producers"=list(
list(
"name"="name here",
"abbr"="abbreviation"
)
)
),
study_desc=list(
"title_statement"= list(
"idno"= "survey-idno-test",
"title"= "string",
"sub_title"= "string",
"alternate_title"= "string",
"translated_title"= "string"
),
"study_info"=list(
"nation"=list(
list(
"name"="Test",
"abbreviation"="tst")
)
)
)
)
microdata_add (
idno="survey-idno-test",
type="survey",
published = 1,
overwrite = "yes",
metadata = metadata,
additional = NULL
)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.