get_file_from_dv: Get file from dataverse

In ready4-dev/ready4use: Ingest, Label, Visualise and Share Health Economic Model Datasets

Get file from dataverse

Description

get_file_from_dv() is a Get function that extracts data from an object. Specifically, this function implements an algorithm to get file from dataverse. The function is called for its side effects and does not return a value.

Usage

get_file_from_dv(
  ds_ui_1L_chr,
  fl_nm_1L_chr,
  save_fmt_1L_chr,
  repo_fl_fmt_1L_chr,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  key_1L_chr = Sys.getenv("DATAVERSE_KEY"),
  options_chr = c("Y", "N"),
  server_1L_chr = Sys.getenv("DATAVERSE_SERVER"),
  save_type_1L_chr = "original",
  save_dir_path_1L_chr = "",
  read_fn,
  unlink_1L_lgl = T
)

Arguments

ds_ui_1L_chr	Dataset user interface (a character vector of length one)
fl_nm_1L_chr	File name (a character vector of length one)
save_fmt_1L_chr	Save format (a character vector of length one)
repo_fl_fmt_1L_chr	Repository file format (a character vector of length one)
consent_1L_chr	Consent (a character vector of length one), Default: ”
consent_indcs_int	Consent indices (an integer vector), Default: 1
key_1L_chr	Key (a character vector of length one), Default: Sys.getenv("DATAVERSE_KEY")
options_chr	Options (a character vector), Default: c("Y", "N")
server_1L_chr	Server (a character vector of length one), Default: Sys.getenv("DATAVERSE_SERVER")
save_type_1L_chr	Save type (a character vector of length one), Default: 'original'
save_dir_path_1L_chr	Save directory path (a character vector of length one), Default: ”
read_fn	Read (a function)
unlink_1L_lgl	Unlink (a logical vector of length one), Default: T

Value

file_xxx (An object)

ready4-dev/ready4use documentation built on June 1, 2025, 2:06 p.m.