RESIDE
RESIDE - R package for simulation of data from marginal distributions from TREs
Science Score: 75.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
✓Institutional organization owner
Organization hehta has institutional domain (www.gla.ac.uk) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.1%) to scientific vocabulary
Repository
RESIDE - R package for simulation of data from marginal distributions from TREs
Basic Info
- Host: GitHub
- Owner: hehta
- License: gpl-3.0
- Language: R
- Default Branch: main
- Homepage: https://hehta.github.io/RESIDE/
- Size: 3.51 MB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
- Releases: 5
Metadata Files
README.md
RESIDE: Rapid Easy Synthesis to Inform Data Extraction 
An R package which allows data to be simulation from marginal distributions obtained from Trusted Research Environments (TREs).
Installation
CRAN
The latest release of this package can be installed from CRAN:
install.packages("RESIDE")
Additionally the development version of this package can be installed using devtools or remotes:
Devtools
install.packages("devtools")
devtools::install_github("hehta/RESIDE")
Remotes
install.packages("remotes")
remotes::install_github("hehta/RESIDE")
Usage
Trusted Research Environments (TRE's)
There are two main functions:
get_marginal_distributions()
This function will get the marginal distributions and store them in an R object. See the documentation on exporting marginal distributions for further information.
export_marginal_distributions()
This function will export the marginal distributions to csv files. See the documentation on exporting marginal distributions for further information.
End Users
Once you have obtained the marginal distributions from a TRE, you can import them and simulated data using the following functions:
import_marginal_distributions()
This function will import the marginal distributions from the csv files provided by a TRE and store them in an R object. See the documentation on importing marginal distributions for further information.
synthesise_data()
This function will synthesise data based on the imported marginal distributions. See the documentation on synthesising data for further information.
Worked Example Using the Internation Stroke Trial
A worked example using the International Stroke Trial is available in the documentation.
Funding
This work was supported by the UKRI Strength in Places Fund (SIPF) Competition, project number 107140. The project title is SIPF The Living Laboratory driving economic growth in Glasgow through real world implementation of precision medicine.
Owner
- Name: Heath Economics and Health Technology Assesment
- Login: hehta
- Kind: organization
- Location: United Kingdom
- Website: https://www.gla.ac.uk/schools/healthwellbeing/research/hehta/
- Twitter: UofGHEHTA
- Repositories: 1
- Profile: https://github.com/hehta
HEHTA - SHW - University of Glasgow
Citation (CITATION.cff)
# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
cff-version: 1.2.0
message: 'To cite package "RESIDE" in publications use:'
type: software
license: GPL-3.0-or-later
title: 'RESIDE: Rapid Easy Synthesis to Inform Data Extraction'
version: 0.3.3
abstract: An R package which allows data to be simulation from marginal distributions
obtained from Trusted Research Environments (TREs).
authors:
- family-names: Field
given-names: Ryan
email: ryan.field@glasgow.ac.uk
orcid: https://orcid.org/0000-0002-4424-9890
- family-names: McAllister
given-names: David
email: david.mcallister@glasgow.ac.uk
orcid: https://orcid.org/0000-0003-3550-1764
url: https://hehta.github.io/RESIDE/
contact:
- family-names: Field
given-names: Ryan
email: ryan.field@glasgow.ac.uk
orcid: https://orcid.org/0000-0002-4424-9890
references:
- type: software
title: testthat
abstract: 'testthat: Unit Testing for R'
notes: Suggests
url: https://testthat.r-lib.org
repository: https://CRAN.R-project.org/package=testthat
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
year: '2024'
doi: 10.32614/CRAN.package.testthat
version: '>= 3.0.0'
- type: software
title: lifecycle
abstract: 'lifecycle: Manage the Life Cycle of your Package Functions'
notes: Suggests
url: https://lifecycle.r-lib.org/
repository: https://CRAN.R-project.org/package=lifecycle
authors:
- family-names: Henry
given-names: Lionel
email: lionel@posit.co
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
orcid: https://orcid.org/0000-0003-4757-117X
year: '2024'
doi: 10.32614/CRAN.package.lifecycle
- type: software
title: 'R: A Language and Environment for Statistical Computing'
notes: Depends
url: https://www.R-project.org/
authors:
- name: R Core Team
institution:
name: R Foundation for Statistical Computing
address: Vienna, Austria
year: '2024'
version: '>= 2.10'
- type: software
title: dplyr
abstract: 'dplyr: A Grammar of Data Manipulation'
notes: Imports
url: https://dplyr.tidyverse.org
repository: https://CRAN.R-project.org/package=dplyr
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
orcid: https://orcid.org/0000-0003-4757-117X
- family-names: François
given-names: Romain
orcid: https://orcid.org/0000-0002-2444-4226
- family-names: Henry
given-names: Lionel
- family-names: Müller
given-names: Kirill
orcid: https://orcid.org/0000-0002-1416-3412
- family-names: Vaughan
given-names: Davis
email: davis@posit.co
orcid: https://orcid.org/0000-0003-4777-038X
year: '2024'
doi: 10.32614/CRAN.package.dplyr
- type: software
title: magrittr
abstract: 'magrittr: A Forward-Pipe Operator for R'
notes: Imports
url: https://magrittr.tidyverse.org
repository: https://CRAN.R-project.org/package=magrittr
authors:
- family-names: Bache
given-names: Stefan Milton
email: stefan@stefanbache.dk
- family-names: Wickham
given-names: Hadley
email: hadley@rstudio.com
year: '2024'
doi: 10.32614/CRAN.package.magrittr
- type: software
title: bestNormalize
abstract: 'bestNormalize: Normalizing Transformation Functions'
notes: Imports
url: https://petersonr.github.io/bestNormalize/
repository: https://CRAN.R-project.org/package=bestNormalize
authors:
- family-names: Peterson
given-names: Ryan Andrew
email: ryan.a.peterson@cuanschutz.edu
orcid: https://orcid.org/0000-0002-4650-5798
year: '2024'
doi: 10.32614/CRAN.package.bestNormalize
- type: software
title: RDP
abstract: 'RDP: The Ramer-Douglas-Peucker Algorithm'
notes: Imports
url: https://github.com/robertdj/RDP
repository: https://CRAN.R-project.org/package=RDP
authors:
- family-names: Dahl Jacobsen
given-names: Robert
email: cran@dahl-jacobsen.dk
year: '2024'
doi: 10.32614/CRAN.package.RDP
- type: software
title: methods
abstract: 'R: A Language and Environment for Statistical Computing'
notes: Imports
authors:
- name: R Core Team
institution:
name: R Foundation for Statistical Computing
address: Vienna, Austria
year: '2024'
- type: software
title: tibble
abstract: 'tibble: Simple Data Frames'
notes: Imports
url: https://tibble.tidyverse.org/
repository: https://CRAN.R-project.org/package=tibble
authors:
- family-names: Müller
given-names: Kirill
email: kirill@cynkra.com
orcid: https://orcid.org/0000-0002-1416-3412
- family-names: Wickham
given-names: Hadley
email: hadley@rstudio.com
year: '2024'
doi: 10.32614/CRAN.package.tibble
- type: software
title: simstudy
abstract: 'simstudy: Simulation of Study Data'
notes: Imports
url: https://kgoldfeld.github.io/simstudy/
repository: https://CRAN.R-project.org/package=simstudy
authors:
- family-names: Goldfeld
given-names: Keith
email: keith.goldfeld@nyulangone.org
orcid: https://orcid.org/0000-0002-0292-8780
- family-names: Wujciak-Jens
given-names: Jacob
email: jacob@wujciak.de
orcid: https://orcid.org/0000-0002-7281-3989
year: '2024'
doi: 10.32614/CRAN.package.simstudy
GitHub Events
Total
- Release event: 1
- Delete event: 1
- Issue comment event: 4
- Push event: 30
- Pull request event: 8
- Create event: 2
Last Year
- Release event: 1
- Delete event: 1
- Issue comment event: 4
- Push event: 30
- Pull request event: 8
- Create event: 2
Packages
- Total packages: 1
-
Total downloads:
- cran 178 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
- Total maintainers: 1
cran.r-project.org: RESIDE
Rapid Easy Synthesis to Inform Data Extraction
- Homepage: https://hehta.github.io/RESIDE/
- Documentation: http://cran.r-project.org/web/packages/RESIDE/RESIDE.pdf
- License: GPL (≥ 3)
-
Latest release: 0.3.2
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v4 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- JamesIves/github-pages-deploy-action v4.5.0 composite
- actions/checkout v4 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- actions/cache v4 composite
- actions/checkout v4 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- R >= 2.10 depends
- RDP * imports
- bestNormalize * imports
- dplyr * imports
- magrittr * imports
- methods * imports
- simstudy * imports
- tibble * imports
- lifecycle * suggests
- testthat >= 3.0.0 suggests