R Observatory: Metrics for RESIDE version 0.4.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

RESIDE

0.4.0Package record

Rapid Easy Synthesis to Inform Data Extraction

0packages depend

2.3Kdownloads / year

98.2%test coverage

13/13flavors OK

Overview

About

Maintained by Ryan FieldCRAN page ↗Website ↗

Assists researchers with planning analysis prior to obtaining data from Trusted Research Environments (TREs), also known as safe havens. Marginal distributions of one or more related data frames can be exported from a TRE and imported elsewhere, where data can be synthesised from them, with or without user specified correlations, by sampling from a multivariate cumulative distribution (copula). The International Stroke Trial (IST) is included as an example dataset under the ODC-By licence, Sandercock et al. (2011) doi:10.7488/ds/104, Sandercock et al. (2011) doi:10.1186/1745-6215-12-101.

Changes in 0.4.0

Breaking changes

export_empty_cor_matrix() and import_cor_matrix() are defunct, correlations are now specified using the correlations parameter of synthesise_data() with the new correlation() function.
The correlation_matrix parameter of synthesise_data() is no longer supported.
synthesise_data() returns a named list of data frames for marginals obtained from multiple data frames.
Requires R >= 4.1.0.

New features

Marginal distributions can be obtained from multiple related data frames, linked by a subject identifier, using get_marginal_distributions().

Show all changes in 0.4.0Hide the rest of the changes in 0.4.0

correlation() creates a correlation between two variables, categorical variables are correlated using a single category (factor_name.x / factor_name.y) and variables of multiple data frames using df_name, df_name.x and df_name.y, including correlations between data frames.
summary() method for RESIDE objects, a higher level summary than print().
print() shows the 10 most common categories of each categorical variable, use print(x, full = TRUE) to print every category.
New vignette, a worked example using multiple tables from the pharmaversesdtm package.

Bug fixes

synthesise_data() keeps whitespace in categories.
synthesise_data() maintains the number of subjects of each data frame.
Categorical marginal distributions are maintained when synthesising with correlations.

From NEWS.md in the release

Install

R (CRAN)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("RESIDE", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-reside

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-RESIDE

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-RESIDE

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

13OK

CRAN check page ↗

Slowest check: 4.8 min · r-oldrel-windows-x86_64

Status changes

OK13 OK2026-10-17
NOTE13 NOTE2026-09-08
ERROR12 NOTE, 1 ERROR2026-09-07
NOTE13 NOTE2026-06-09
ERROR12 NOTE, 1 ERROR2026-06-08

Show 1 earlier changeHide 1 earlier change

NOTE3 OK, 11 NOTE2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 0.4.0

README· In the repository, left out of the releaseVignettesYes · 6 · evaluation depends on the environmentNEWSYes · 100% structured · mentions 0.4.0Citation fileNoWebsiteYes · pkgdown

Help pages: 14 (2 internal)includes a package overview page
Examples that run: 100%9 run in a plain check
Exported functions with examples: 100%
Documented parameters: 100%
Return-value docs: 100%
Help pages citing references: 7%

Vignettes (6)

How these are measured

Downloads

2.3K

CRAN downloads in the past year

Rank #17,019 · ~6/day · ~194/mo

Releases R versions

Daily download trend is not available in this view yet.

35230 days

75090 days

2.3K1 year

Compare downloads with other packages →

Also on64 r2u4 autocran

How downloads are counted

Repository

hehta/reside ↗Organization: hehta

1Stars

1Forks

1Open issues

0Open PRs

6Releases

153Commits

2Commit identities

License file reads as GPL-3.0 · 153 commits · Last activity 2026-09-30 · 0% stars, 30d

Responsiveness

How these are sampled

PRs merged (all time): 96%
Median days to close, 50 most recently updated closed issues: 15
Median days to close, 50 most recently updated closed PRs: 0

Stars over time

2025-10-02 · 12026-07-07 · 1

How these are measured

PracticesBeta

11 development-tooling and community-health practices detected across 6 families in the upstream repository

Checks run against github.com/hehta/reside on 2026-10-21.

Continuous integration (2)

GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Governance and community (2)

Contributing guideIssue templates

Docs source (3)

pkgdown

GitHub Pages site last deployed 2026-09-30 · The repository has a site deploy workflow

pkgdown site last built 2026-09-30

Coverage (1)

Coverage reporting

Show all practicesHide 2 practices

Research and citation (1)

CITATION.cff

Lint, format, editor (2)

VS CodeRStudio project

How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies

12 external dependencies (excludes base and recommended)

Installing RESIDE adds 85 packages (43 with compiled code, 68 MB of source tarballs). Heaviest: BH 14 MB, stringi 11 MB, ggplot2 6.0 MB.

Depends (1)

R >= 4.1.0

Imports (7)

dplyr magrittr bestNormalize RDPmethodstibble simstudy

LinkingTo (0)

none

Suggests (7)

testthat lifecycle knitr rmarkdown DTsurvivalpharmaversesdtm

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

Datasets

People & History

People (3)

Ryan Field

Author, Maintainer since 0.3.2 (2024)

David McAllister

Author

Claudia Geue

Contributor

Releases (2)

Pick two releases to compare their code metrics.

0.4.0Latest
record
2026-09-30 · current release · diff ↗ ·
added 1 export
correlation
R
R 4.6.0 released · 2026-04-24
R
R 4.5.0 released · 2025-04-11
0.3.2
record
2024-10-17
R
R 4.4.0 released · 2024-04-24

Package metadata

First published: 2024-10-17
Total releases: 2 / 2 yrs
License: GPL (>= 3) OSI
Minimum R: ≥ 4.1.0
Bundled data: 503 KB / 1 file
Download size: 598 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("RESIDE")

Format

Field, R., Geue, C., & McAllister, D. (2026). RESIDE: Rapid Easy Synthesis to Inform Data Extraction (Version 0.4.0) [Computer software]. https://doi.org/10.32614/CRAN.package.RESIDE

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

The repository also keeps a CITATION.cff.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for RESIDE version 0.4.0 [Data set]. HJJB, LLC. Data release v2026-10-25. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →