Create a RIDL dataset from list with required fields
Usage
ridl_dataset(
title,
name,
owner_org,
notes,
keywords,
visibility,
geographies,
archived,
external_access_level,
unit_of_measurement,
data_collector,
data_collection_technique,
date_range_start = NULL,
date_range_end = NULL,
short_title = NULL,
tag_string = NULL,
url = NULL,
private = NULL,
data_sensitivity = NULL,
original_id = NULL,
sampling_procedure = NULL,
operational_purpose_of_data = NULL,
hxlated = NULL,
process_status = NULL,
identifiability = NULL,
linked_datasets = NULL,
admin_notes = NULL,
sampling_procedure_notes = NULL,
response_rate_notes = NULL,
data_collection_notes = NULL,
weight_notes = NULL,
clean_ops_notes = NULL,
data_accs_notes = NULL,
ddi = NULL,
kobo_asset_id = NULL,
geog_coverage = NULL,
configuration = NULL
)Arguments
- title
character, Title(*) - Make sure to include: 'Survey name/title', 'Location', 'Country', and 'Year(s)' in the order indicated.
- name
character, URL(*) - The canonical name of the dataset, eg. my-dataset.
- owner_org
character, Data container(*) - Use the canonical name for the container.
- notes
character, Description(*) - Some useful notes about the data. Please include the number of observations.
- keywords
character, Topic classifications(*) - Tags useful for searching for the datasets. Multiple values are allowed.
- visibility
character, Internal Access Level(*). Allowed values:
restricted(Private),public(Internally Visible).- geographies
character, the name of the geographic area. 'UNSPECIFIED' when you don't know
- archived
logical, Archived(*) - Allows users to indicate if the dataset is archived or active. Allowed values:
False(No),True(Yes).- external_access_level
character, External access level(*). Allowed values:
not_available(Not available),direct_access(Direct access),public_use(Public use),licensed_use(Licensed use),data_enclave(Data enclave),open_access(Open access).- unit_of_measurement
character, Unit of measurement(*) - Unit of measurement / observation for the dataset.
- data_collector
character, Data Collector(*) - Which organization owns / collected the data. Multiple values are allowed.
- data_collection_technique
character, Data collection technique(*). Allowed values:
nf(Not specified),f2f(Face-to-face interview),capi(Face-to-face interview: Computerised),cami(Face-to-face interview: Mobile),papi(Face-to-face interview: Paper-and-pencil),tri(Telephone interview),eri(E-mail interview),wri(Web-based interview: audio-visual technology enabling the interviewer(s) and interviewee(s) to communicate in real time),easi(Self-administered questionnaire: E-mail),pasi(Self-administered questionnaire: Paper),sasi(Self-administered questionnaire: SMS/MMS),casi(Self-administered questionnaire: Computer-assisted),cawi(Self-administered questionnaire: Web-based),foc(Face-to-face focus group),tfoc(Telephone focus group),obs(Observation),oth(Other).- date_range_start
Date, Date collection first date - Use dd/mm/yyyy format.
- date_range_end
Date, Date collection last date - Use dd/mm/yyyy format.
- short_title
character, Short title - eg. Short title for the project.
- tag_string
character, Tags - eg. economy, mental health, government.
- url
character, Project URL - Website URL associated with this data project (if applicable).
- private
character, Visibility (Private/Public).
- data_sensitivity
character, Data sensitivity - Apply to both Anonymized and Personally identifiable data. Allowed values:
yes(Yes),no(No).- original_id
character, Original ID - If the dataset already has an ID from the source org, DDI, etc...
- sampling_procedure
character, Sampling Procedure. Multiple values are allowed. Allowed values:
total_universe_complete_enumeration(Total universe/Complete enumeration),probability_simple_random(Probability: Simple random),probability_systematic_random(Probability: Systematic random),probability_stratified(Probability: Stratified),probability_stratified_proportional(Probability: Stratified: Proportional),probability_stratified_disproportional(Probability: Stratified: Disproportional),probability_cluster(Probability: Cluster),probability_cluster_simple_random(Probability: Cluster: Simple random ),probability_cluster_stratified_random(Probability: Cluster: Stratified random),probability_multistage(Probability: Multistage),nonprobability(Non-probability),nonprobability_availability(Non-probability: Availability),nonprobability_purposive(Non-probability: Purposive),nonprobability_quota(Non-probability: Quota),nonprobability_respondentassisted(Non-probability: Respondent-assisted),mixed_probability_nonprobability(Mixed probability and non-probability),other_other(Use if the sampling procedure is known, but not found in the list..).- operational_purpose_of_data
character, Operational purpose of data - Classification of the type of data contained in the file. Multiple values are allowed. Allowed values:
participatory_assessments(Participatory assessments),baseline_household_survey(Baseline Household Survey),rapid_needs_assessment(Rapid Needs Assessment),protection_monitoring(Protection Monitoring),programme_monitoring(Programme monitoring),population_data(Population Data),cartography(Cartography, Infrastructure & GIS).- hxlated
logical, Dataset with resources having HXL tags
- process_status
character, Dataset Process Status. Allowed values:
raw(Raw-Uncleaned),cleaned(Cleaned Only),anonymized(Cleaned & Anonymized).- identifiability
character, Identifiability. Allowd values:
personally_identifiable(Personally identifiable),anonymized_enclave(Anonymized 1st level: Data Enclave - only removed direct identifiers),anonymized_scientific(Anonymized 2st level: Scientific Use File (SUF)),anonymized_public(Anonymized 3rd level: Public Use File (PUF)).- linked_datasets
character, Linked Datasets - Links to other RIDL datasets. It supports multiple selections.
- admin_notes
character, Admin Notes - General. You can use Markdown formatting here.
- sampling_procedure_notes
character, Admin Notes - Sampling Procedure. You can use Markdown formatting here.
- response_rate_notes
character, Admin Notes - Response Rate. You can use Markdown formatting here.
- data_collection_notes
character, Admin Notes - Data Collection. You can use Markdown formatting here.
- weight_notes
character, Admin Notes - Weighting. You can use Markdown formatting here.
- clean_ops_notes
character, Admin Notes - Cleaning. You can use Markdown formatting here.
- data_accs_notes
character, Admin Notes - Access authority. You can use Markdown formatting here.
- ddi
DDI.
- kobo_asset_id
character, the KoBoToolbox asset id.
- geog_coverage
character, Additional notes for geographic coveraage. Complement the Geographic coverage field, e.g National coverage, or name of the area, etc.
- configuration
RIDLConfig, RIDL configuration used