Patch a resource on RIDL

Usage

ridl_resource_patch(
  resource,
  type = NULL,
  file_type = NULL,
  measurement_unit = NULL,
  methodology = NULL,
  date_range_start = NULL,
  date_range_end = NULL,
  version = NULL,
  process_status = NULL,
  identifiability = NULL,
  file_to_upload = NULL,
  url = NULL,
  name = NULL,
  description = NULL,
  format = NULL,
  hxlated = NULL,
  authors = NULL,
  script_field_name = NULL,
  script_methods = NULL,
  script_instructions = NULL,
  script_dependencies = NULL,
  script_zip_package = NULL,
  script_date = NULL,
  license_name = NULL,
  license_uri = NULL,
  visibility = NULL,
  limitations = NULL,
  dimensions = NULL,
  statistical_concept = NULL,
  time_periods = NULL,
  confidentiality = NULL,
  confidentiality_status = NULL,
  confidentiality_note = NULL,
  script_software = NULL,
  source_code_repo = NULL,
  periodicity = NULL,
  kobo_type = NULL,
  kobo_details = NULL,
  configuration = NULL
)

rr_patch(
  resource,
  type = NULL,
  file_type = NULL,
  measurement_unit = NULL,
  methodology = NULL,
  date_range_start = NULL,
  date_range_end = NULL,
  version = NULL,
  process_status = NULL,
  identifiability = NULL,
  file_to_upload = NULL,
  url = NULL,
  name = NULL,
  description = NULL,
  format = NULL,
  hxlated = NULL,
  authors = NULL,
  script_field_name = NULL,
  script_methods = NULL,
  script_instructions = NULL,
  script_dependencies = NULL,
  script_zip_package = NULL,
  script_date = NULL,
  license_name = NULL,
  license_uri = NULL,
  visibility = NULL,
  limitations = NULL,
  dimensions = NULL,
  statistical_concept = NULL,
  time_periods = NULL,
  confidentiality = NULL,
  confidentiality_status = NULL,
  confidentiality_note = NULL,
  script_software = NULL,
  source_code_repo = NULL,
  periodicity = NULL,
  kobo_type = NULL,
  kobo_details = NULL,
  configuration = NULL
)

Arguments

resource: RIDLResource, the resource to patch
type: character, Resource type(*) - The kind of file you want to upload. Allowed values: data (Data file), attachment (Additional attachment).
file_type: character, File type(*) - Indicates what is contained in the file. Allowed values: microdata (Microdata), questionnaire (Questionnaire), report (Report), sampling_methodology (Sampling strategy & methodology Description), infographics (Infographics & Dashboard), script (Script), concept note (Concept Note), other (Other).
measurement_unit: character, the unit of measurement
methodology: character, This element documents methodological details on the production of the series or indicator.
date_range_start: Date, Data collection first date(*) - Use yyyy-mm-dd format.
date_range_end: Date, Data collection last date(*) - Use yyyy-mm-dd format.
version: character, Version(*).
process_status: character, File process status(*) - Indicates the processing stage of the data. 'Raw' means that the data has not been cleaned since collection. 'In process' means that it is being cleaned. 'Final' means that the dataset is final and ready for use in analytical products. Allowed valued: raw (Raw-Uncleaned), cleaned (Cleaned Only), anonymized (Cleaned & Anonymized).
identifiability: character, Identifiability(*) - Indicates if personally identifiable data is contained in the dataset. Allowed 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 3st level: Public Use File (PUF)).
file_to_upload: character, path of the file to upload
url: character, Upload - The file name as it will be recorded in the system.
name: character, the name of the resource
description: character, Description - Some usefule notes about the data.
format: character, File format - eg. CSV, XML, or JSON.
hxlated: logical, HXL-ated. Allowed values: False (No), True (Yes).
authors: character, authors
script_field_name: character, name of the script field
script_methods: character, statistical/analytic methods included in the script
script_instructions: character, instructions for running the script. Information on the sequence in which the scripts must be run is critical.
script_dependencies: character, dependencies (packages/libraries) that the script relies on.
script_zip_package: character, Script ZIP package
script_date,: character, date of the script
license_name: character, script license name
license_uri: character, script license uri
visibility: character, Internal Access Level(*). Allowed values: restricted (Private), public (Internally Visible).
limitations: character, limitations
dimensions: character, dimensions
statistical_concept: character, statistical concept used
time_periods: character, time periods
confidentiality: character, confidentiality
confidentiality_status: character, confidentiality status
confidentiality_note: character, confidentiality note
script_software: character, software used to run the script
source_code_repo: character, repository (e.g. GitHub repo) where the script has been published.
periodicity: character, periodicity
kobo_type: character, type
kobo_details: character, details
configuration: RIDLConfig, the configuration

Value

RIDLResource, the resource