share-methods: Share data via an online repository

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

Share data via an online repository

Description

share method applied to Ready4useRecord

share method applied to Ready4useRepos

Usage

## S4 method for signature 'Ready4useRecord'
share(
  x,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  gh_prerelease_1L_lgl = T,
  gh_repo_desc_1L_chr = "Supplementary Files",
  key_1L_chr = Sys.getenv("DATAVERSE_KEY"),
  options_chr = c("Y", "N"),
  publish_dv_1L_lgl = F,
  type_1L_chr = "prefer_dv",
  ...
)

## S4 method for signature 'Ready4useRepos'
share(
  x,
  obj_to_share_xx,
  fl_nm_1L_chr,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  description_1L_chr = NA_character_,
  gh_prerelease_1L_lgl = T,
  gh_repo_desc_1L_chr = "Supplementary Files",
  key_1L_chr = Sys.getenv("DATAVERSE_KEY"),
  options_chr = c("Y", "N"),
  publish_dv_1L_lgl = T,
  type_1L_chr = "prefer_dv",
  ...
)

Arguments

x	An object of class Ready4useRepos
consent_1L_chr	Consent (a character vector of length one), Default: ”
consent_indcs_int	Consent indices (an integer vector), Default: 1
gh_prerelease_1L_lgl	Github prerelease (a logical vector of length one), Default: T
gh_repo_desc_1L_chr	Github repository description (a character vector of length one), Default: 'Supplementary Files'
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")
publish_dv_1L_lgl	Publish dataverse (a logical vector of length one), Default: T
type_1L_chr	Type (a character vector of length one), Default: 'prefer_dv'
...	Additional arguments
obj_to_share_xx	Object to share (an output object of multiple potential types)
fl_nm_1L_chr	File name (a character vector of length one)
description_1L_chr	Description (a character vector of length one), Default: 'NA'

Value

x (An object of class Ready4useRecord)

Y (Ingested data, descriptive metadata and provenance details.)

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