R Observatory: Metrics for redcapAPI version 2.12.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

redcapAPI

2.12.0Package record

Interface to 'REDCap'

3packages dependsuggested by 1

18Kdownloads / year

0.0%test coverage

8/13flavors OK

Overview

About

Maintained by Shawn GarbettCRAN page ↗GitHub ↗Issues ↗

Access data stored in 'REDCap' databases using the Application Programming Interface (API). 'REDCap' (Research Electronic Data CAPture; https://projectredcap.org, Harris, et al. (2009) doi:10.1016/j.jbi.2008.08.010, Harris, et al. (2019) doi:10.1016/j.jbi.2019.103208) is a web application for building and managing online surveys and databases developed at Vanderbilt University. The API allows users to access data and project meta data (such as the data dictionary) from the web programmatically. The 'redcapAPI' package facilitates the process of accessing data with options to prepare an analysis-ready data set consistent with the definitions in a database's data dictionary.

Changes in 2.12.0

Breaking changes

unlockREDCap upstream dependency on shelter now default to 'SHELTER_' prefix when looking for ENV variable overrides.

Minor improvements and fixes

exportDags, exportFieldNames, exportProjectInformation, exportReportsTyped, importDags, writeDataForImport, and exportRecordsTyped now have a csv_delimiter parameter to control delimiter utilized.
importMetaData bug fix when given duplicate names to exit and warn user properly.
redcapUserRoleStructure allows new alerts, api_modules, and data_quality_resolution attributes.
exportUsers properly handles the columns random_setup, random_dashboard and random_perform.
importUsers and exportUsers weren't handling data_access_group assignment properly.
exportUserRoles now avoids errors when user role access columns are missing from export responses.
exportFileRepositoryListing returns a data.frame with 6 columns (was 4) from REDCap version 16.0.8 and up.
redcapConnection has better documentation on setting the CSV delimiter and this is respected through most calls except for ones that have been shown to be hard coded to commas by REDCap.

DEPRECATION NOTICES

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

A future release of version 3.0.0 will introduce several breaking changes!

The exportRecords function interface will be replaced. Please switch your processes to exportRecordsTyped
The importRecords function interface will be replaced to utilize castForImport to prepare data for import. Validation logs will no longer be printed.
The redcapFactor class is being discontinued with all its supporting methods (including redcapFactorFlip). Please use recastRecords instead.
The recodeCheck function is being discontinued. Please use recastRecords instead.

From NEWS.md in the release

Install

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

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

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

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("vubiostat/redcapAPI")

Development version from vubiostat/redcapAPI. Installs pak first if it is not already available.

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-redcapapi

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-redcapAPI

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-redcapAPI

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

5NOTE8OK

Check messages

NOTER code for possible problemsr-devel-linux-x86_64-debian-clang, r-devel-linux-x86_64-debian-gcc, r-devel-linux-x86_64-fedora-clang, r-devel-linux-x86_64-fedora-gcc, r-devel-windows-x86_64

Found calls to structure() using deprecated special names:
  redcapAPI/R/importRecords.R (.Names: 2)
'.Names' should be changed to 'names'.

CRAN check page ↗

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

Status changes

NOTE8 OK, 5 NOTENow
NOTE10 OK, 3 NOTE2026-07-16
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 2.12.0

READMEYes · 2,076 wordsVignettesYes · 7 · staticNEWSYes · 100% structured · mentions 2.12.0Citation fileYes · computed when R runs itWebsitenot declared in DESCRIPTION

Help pages: 77 (1 internal)includes a package overview page
Examples that run: 2%1 run in a plain check · 58 never run
Exported functions with examples: 89%
Documented parameters: 98%
Return-value docs: 73%
Help pages citing references: 0%

Vignettes (7)

How these are measured

Downloads

18K

CRAN downloads in the past year

Rank #3,172 · ~49/day · ~1.5K/mo

Releases R versions

Daily download trend is not available in this view yet.

1.2K30 days

3.8K90 days

18K1 year

Compare downloads with other packages →

Also on180 r2u8 autocran178 c2d4u

How downloads are counted

Repository

vubiostat/redcapapi ↗Organization: vubiostat

34Stars

28Forks

18Open issues

2Open PRs

16Releases

2,695Commits

28Commit identities

2,695 commits · Last activity 2026-10-16 · +3% stars, 30d · Default branch at 2.12.0.9000, ahead of CRAN 2.12.0 (checked 2026-10-18)

Responsiveness

How these are sampled

PRs merged (all time): 93%
Median days to close, 50 most recently updated closed issues: 5
Median days to close, 50 most recently updated closed PRs: 1

Stars over time

2025-07-27 · 262026-10-15 · 34

How these are measured

PracticesBeta

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

Checks run against github.com/vubiostat/redcapapi on 2026-10-18.

Continuous integration (4)

GitHub ActionsR CMD check workflowGitLab CITravis CI (config file)

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

CRAN release process (1)

cran-comments.md

Research and citation (1)

Zenodo

How this is detected·Detection ruleset v3 (2026-09-26)

Dependencies

Declared dependencies

12 external dependencies (excludes base and recommended)

Installing redcapAPI adds 18 packages (13 with compiled code, 3.9 MB of source tarballs). Heaviest: jsonlite 1.0 MB, curl 714 KB, sodium 457 KB.

Depends (1)

R >= 3.5.0

Imports (8)

checkmate chron curl jsonlite labelVector lubridate mime shelter

LinkingTo (0)

none

Suggests (4)

testthat Hmisc mockery R.rsp

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

3direct

0indirect

Imports 3

Suggested by 1

Depends, Imports or LinkingTo, most downloaded first

REDCapSync ReviewR rccola

Suggests, most downloaded first

tidyREDCap

How these are counted

Code & Tests

Datasets

People & History

People (20)

Shawn Garbett

Maintainer since 2.3.3 (2023), Contributor · added in 2.3.3

Jeffrey Horner

Author

Benjamin Nutter

Contributor, Author · added in 2.0

Will Beasley

Contributor

Cole Beck

Contributor · added in 2.7.1

Philip Chase

Contributor · added in 2.8.4

Michael Chirico

Contributor · added in 2.11.0

Will Gray

Contributor

Brian High

Contributor · added in 2.8.4

Tan Hsi-Nien

Contributor · added in 2.8.4

Bradley Johnson

Contributor · added in 2.8.4

Show 9 more contributorsHide 9 contributors

Nick Kennedy

Contributor · added in 2.8.4

Stephen Lane

Contributor · added in 2.0

Marcus Lehr

Contributor · added in 2.3

Thomas Obadia

Contributor · added in 2.8.4

Savannah Obregon

Contributor · added in 2.7.1

William Sharp

Contributor · added in 2.11.0

Jeremy Stephens

Contributor

Alexander Strübing

Contributor · added in 2.12.0

Paddy Tobias

Contributor · added in 2.8.4

Previously maintained by Benjamin Nutter (2.0 to 2.3) and Stephen Lane (1.3).

Releases (25)

Pick two releases to compare their code metrics.

R
R 4.6.0 released · 2026-04-24
2.12.0Latest
record
2026-03-23 · current release · diff ↗
2.11.5
record
2025-12-09 · diff ↗
2.11.4
record
2025-10-29 · diff ↗
2.11.3
record
2025-09-11 · diff ↗ ·
removed 2 exports
exportBundle, redcapProjectInfo

added 5 exports
createSplunkFUN, logEvent, logMessage, logStop, logWarning
2.11.1
record
2025-08-18 · diff ↗ ·
added 1 export
exportSAS
2.11.0
record
2025-06-05 · diff ↗ ·
added 2 exports
connectAndCheck, exportPdf
R
R 4.5.0 released · 2025-04-11
2.10.0
record
2024-10-17 · diff ↗
2.9.1
record
2024-05-16 · diff ↗ ·
added 1 export
exportDataQuality
R
R 4.4.0 released · 2024-04-24
2.9.0
record
2024-04-19 · diff ↗ ·
added 1 export
importFileToRecord
2.8.4
record
2024-01-31 · diff ↗ ·
added 10 exports
REDCAP_PROJECT_PURPOSE, assembleCodebook, castLogical, changedRecords, createRedcapProject, exportFilesMultiple, exportProjectXml, readPreservedProject, skip_validation, valSkip
2.8.0
record
2023-09-13 · diff ↗ ·
removed 1 export
exportPdf

added 24 exports
castCheckCodeCharacter, castCheckLabelCharacter, castCheckedCharacter, castCodeCharacter, castLabelCharacter, default_cast_character, default_cast_no_factor, deleteDags, deleteUserRoles, deleteUsers, exportSurveyLink, exportSurveyQueueLink, exportSurveyReturnCode, exportUserDagAssignments, exportUserRoleAssignments, exportUserRoles, importDags, importUserDagAssignments, importUserRoleAssignments, importUserRoles, importUsers, renameRecord, reviewInvalidRecords, switchDag
2.7.4
record
2023-07-17 · diff ↗ ·
added 2 exports
exportDags, prepUserImportData
2.7.1
record
2023-06-12 · diff ↗ ·
removed 1 export
genericApiCall

added 56 exports
REDCAP_METADATA_FIELDTYPE, REDCAP_METADATA_VALIDATION_TYPE, REDCAP_REPEAT_INSTRUMENT_STRUCTURE, castCheckCode, castCheckForImport, castCheckLabel, castChecked, castCode, castDpCharacter, castDpNumeric, castForImport, castLabel, castRaw, castTimeHHMM, castTimeMMSS, createFileRepositoryFolder, deleteEvents, deleteFileRepository, deleteFromFileRepository, exportBulkRecords, exportFileRepository, exportFileRepositoryListing, exportFromFileRepository, exportRecordsTyped, exportRepeatingInstrumentsEvents, exportReportsTyped, guessCast, guessDate, importEvents, importFileRepository and 26 more

Show 22 earlier eventsHide 22 earlier events

R
R 4.3.0 released · 2023-04-21
2.5.0
record
2023-03-24 · diff ↗ ·
added 7 exports
REDCAP_SYSTEM_FIELDS, deleteArms, exportLogging, fieldChoiceMapping, makeApiCall, missingSummary, missingSummary_offline
2.4.0
record
2023-03-01 · diff ↗
2.3.3
record
2023-01-26 · diff ↗ ·
added 1 export
deleteRecords
R
R 4.2.0 released · 2022-04-22
R
R 4.1.0 released · 2021-05-18
R
R 4.0.0 released · 2020-04-24
2.3
record
2020-02-17 · diff ↗ ·
added 1 export
exportSurveyParticipants
R
R 3.6.0 released · 2019-04-26
2.2
record
2018-08-01 · diff ↗ ·
added 2 exports
genericApiCall, importArms
2.1
record
2018-05-11 · diff ↗ ·
added 2 exports
allocationTable, exportNextRecordName
R
R 3.5.0 released · 2018-04-23
2.0
record
2018-01-18 · diff ↗ ·
removed 1 export
allocationTable

added 5 exports
checkbox_suffixes, exportBundle, exportFieldNames, exportPdf, exportProjectInformation
R
R 3.4.0 released · 2017-04-21
R
R 3.3.0 released · 2016-05-03
R
R 3.2.0 released · 2015-04-16
1.3
record
2015-03-14 · diff ↗ ·
removed 30 exports
allocationTable.redcapApiConnection, allocationTable.redcapDbConnection, deleteFiles.redcapApiConnection, deleteFiles.redcapDbConnection, exportArms.redcapApiConnection, exportArms.redcapDbConnection, exportEvents.redcapApiConnection, exportEvents.redcapDbConnection, exportFiles.redcapApiConnection, exportFiles.redcapDbConnection, exportInstruments.redcapApiConnection, exportInstruments.redcapDbConnection, exportMappings.redcapApiConnection, exportMappings.redcapDbConnection, exportMetaData.redcapApiConnection, exportMetaData.redcapDbConnection, exportRecords.redcapApiConnection, exportRecords.redcapDbConnection, exportReports.redcapApiConnection, exportReports.redcapDbConnection, exportUsers.redcapApiConnection, exportUsers.redcapDbConnection, exportVersion.redcapApiConnection, exportVersion.redcapDbConnection, importFiles.redcapApiConnection, importFiles.redcapDbConnection, importRecords.redcapApiConnection, importRecords.redcapDbConnection, redcapProjectInfo.redcapApiConnection, redcapProjectInfo.redcapDbConnection

added 1 export
parseBranchingLogic
1.2
record
2015-01-16 · diff ↗ ·
added 33 exports
allocationTable, allocationTable.redcapApiConnection, allocationTable.redcapDbConnection, allocationTable_offline, deleteFiles.redcapApiConnection, deleteFiles.redcapDbConnection, exportArms.redcapApiConnection, exportArms.redcapDbConnection, exportEvents.redcapApiConnection, exportEvents.redcapDbConnection, exportFiles.redcapApiConnection, exportFiles.redcapDbConnection, exportInstruments.redcapApiConnection, exportInstruments.redcapDbConnection, exportMappings.redcapApiConnection, exportMappings.redcapDbConnection, exportMetaData.redcapApiConnection, exportMetaData.redcapDbConnection, exportRecords.redcapApiConnection, exportRecords.redcapDbConnection, exportRecords_offline, exportReports.redcapApiConnection, exportReports.redcapDbConnection, exportUsers.redcapApiConnection, exportUsers.redcapDbConnection, exportVersion.redcapApiConnection, exportVersion.redcapDbConnection, importFiles.redcapApiConnection, importFiles.redcapDbConnection, importRecords.redcapApiConnection and 3 more
1.1
record
2014-11-25 · diff ↗
1.0.1
record
2014-10-21 · diff ↗
1.0
record
2014-09-16
R
R 3.1.0 released · 2014-04-10

Package metadata

First published: 2014-09-16
Total releases: 25 / 12 yrs
License: GPL-2 OSI
Minimum R: ≥ 3.5.0
Download size: 2.8 MB

Appears in task views

Web Technologies and Services

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("redcapAPI")

The package provides a citation file that builds its entry when R runs it. Run citation() to see it.

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 redcapAPI version 2.12.0 [Data set]. HJJB, LLC. Data release v2026-10-21. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-21, 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 →