Companion R Package for the 'formr' Survey Framework
Overview
Serves as a companion toolkit for the 'formr' survey framework (https://rforms.org). The package acts as a bridge between a 'formr' server and a local R environment. Key features include an API client for fetching, type-casting, and automatically scoring data; a project management workflow for syncing study assets (surveys, CSS) for local editing; and functions for use within 'formr' runs to generate dynamic, personalized feedback plots and to simplify survey logic.
- **CRAN resubmission fixes (addressing the 1.0.0 review):**
- Every exported function and method now documents its return value with
\value, describing the class/structure and meaning of the output. - Functions no longer write informational output with
cat()/print(). Progress and status messages now usemessage()and can be silenced with a newverboseargument; the warnings before destructive actions usewarning(). The confirmation prompt now only appears in interactive sessions: destructive/overwriting calls (formr_api_delete_run(),formr_api_delete_survey(),formr_api_delete_all_files(),formr_api_backup_run(),formr_api_pull_project()) **error** in a non-interactive session rather than proceeding unattended — passprompt = FALSEto confirm in scripts.
Show all changes in 1.1.0Hide the rest of the changes in 1.1.0
- New
formr_default_dir()sets a session-wide default output directory. The writing helpers (formr_backup_study(),formr_backup_surveys(),formr_backup_files(),formr_api_backup_run(),formr_api_pull_project(),formr_api_push_project()) no longer default to the working directory: setformr_default_dir()once, or passdir/save_pathexplicitly. In examples, vignettes and tests these write only totempdir(). - Vignettes now execute code — API calls are replayed offline from bundled
vcrcassettes, and the reverse/aggregate pipeline runs on bundled example data — so users can run them and CRAN can test them. \dontrun{}examples now begin with a one-line comment explaining why they are not run.- **
formr_api_fetch_results()now defaultsrun_nameto.formr$run_name**, matchingformr_api_results()andformr_overview_sankey(). Code running inside an OpenCPU session on rforms.org can omit the argument; outside, the function errors with a clear message if the run name is unset. - **Vignette rework:
run-r-inside-your-study.Rmd** gains end-to-end walkthroughs for the v1 API's cross-session data path -- a participant counter, real-time group norms, dynamic group balancing, and a waiting-room synchronisation pattern. Smaller clarifications in the fetch-and-process-results, manage-your-sessions, and manage-your-surveys vignettes. - **
docs/is no longer tracked.** Deployment to the pkgdown site is already handled by.github/workflows/pkgdown.yamlpushing togh-pages, so the in-tree mirror was redundant and went stale on every PR.
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-05
- NOTE12 OK, 1 NOTE2026-08-01
- OK7 OK2026-06-17
Documentation
- Help pages
- 104 (1 internal)
- Examples that run
- 60%34 run in a plain check · 23 never run
- Exported functions with examples
- 57%
- Documented parameters
- 100%
- Return-value docs
- 100%
- Help pages citing references
- 0%
Downloads
Repository
- PRs merged (all time)
- 85%
- Median days to close, 50 most recently updated closed issues
- 150
- Median days to close, 50 most recently updated closed PRs
- 1
Stars over time
Forks over time
Releases over time
Issues over time
PRs over time
Commits over time
10 development-tooling and community-health practices detected across 6 families in the upstream repository
Checks run against github.com/rubenarslan/formr on 2026-10-21.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
GitHub Pages site last deployed 2026-10-06 · The repository has a site deploy workflow
pkgdown site last built 2026-10-06
Show all practicesHide 2 practices
This repository shows signs of AI coding tools.
- Claude Codefirst seen 2026-04-23Seen in the repository: CLAUDE.mdNamed in .Rbuildignore: .claude, CLAUDE.mdNamed in .gitignore: .claudePull request it wrote: opened by a project memberCommits: 3 by its own account · at least 21 crediting it in the message
- Claude Opus 4.710 commits · May 2026
- Claude Opus 4.85 commits · May to Jun 2026
- Claude Fable 53 commits · Jul 2026
- Claude Opus 5.52 commits · Oct 2026
- Claude Sonnet 51 commit · Jul 2026
Dependencies
Code & Tests
People & History
- 1.1.0Latest2026-06-16 · current release
- RR 4.6.0 released · 2026-04-24
Package metadata
- First published
- 2026-06-16
- Total releases
- 1 / 1 yrs
- License
- MIT + file LICENSE OSI
- Minimum R
- ≥ 4.1.0
- Download size
- 480 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("formr")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-23, which the citation names so these numbers can be found later. More on citing and the projects behind them.