allofus R Package

R-CMD-check CRAN status DOI

The goal of the allofus R package is to streamline the use of R within the All of Us Researcher Workbench. It has 4 primary goals:

  1. Facilitate the use of popular tidyverse ecosystem of R packages on the Researcher Workbench
  2. Help researchers more efficiently and accurately extract and synthesize survey data and EHR data
  3. Increase the interoperability between tools created by the Observational Health Data Sciences and Informatics community (OHDSI) for the OMOP CDM) and the Researcher Workbench
  4. Make connecting to the database and managing files simple

The allofus R package was developed by Louisa Smith and Rob Cavanaugh at Northeastern University and is not affiliated with or endorsed by the All of Us Research Program.

Installation

Install the released version of allofus from CRAN:

install.packages("allofus")

Install the development version from Github:

install.packages("pak")
pak::pak("roux-ohdsi/allofus")

On the new RStudio interface on the workbench, you will need to manually specify the CRAN mirror to be able to download any recently updated packages.

# specify the mirror directly
install.packages("allofus", repos = "https://cloud.r-project.org")

# OR set the mirror as an option at the top of your script
options(repos = c(CRAN = "https://cloud.r-project.org"))

# Github development versions may requires using the remotes package
install.packages("remotes")
remotes::install_github("roux-ohdsi/allofus", repos = "https://cloud.r-project.org")

Use

Read through the getting started vignette to learn how to use the package.

Citation

Please cite the allofus package as:

Smith L, Cavanaugh R (2023). allofus: Interface for ‘All of Us’ Researcher Workbench. doi:10.5281/zenodo.10420610, https://roux-ohdsi.github.io/allofus/.

or with

citation("allofus")

Bugs

Please leave us comments, requests, and report bugs using the “Issues” tab on github.