Skip to content

formr

1.1.0Package record

Companion R Package for the 'formr' Survey Framework

0packages depend
1.5Kdownloads / year
45.0%test coverage
13/13flavors OK

Overview

About

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.

Changes in 1.1.0
  • **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 use message() and can be silenced with a new verbose argument; the warnings before destructive actions use warning(). 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 — pass prompt = FALSE to 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: set formr_default_dir() once, or pass dir/save_path explicitly. In examples, vignettes and tests these write only to tempdir().
  • Vignettes now execute code — API calls are replayed offline from bundled vcr cassettes, 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 defaults run_name to .formr$run_name**, matching formr_api_results() and formr_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.yaml pushing to gh-pages, so the in-tree mirror was redundant and went stale on every PR.

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 3.4 min · r-oldrel-windows-x86_64
Status changes
  • OK13 OK2026-08-05
  • NOTE12 OK, 1 NOTE2026-08-01
  • OK7 OK2026-06-17
Advisories

none known

Documentation

In release 1.1.0
READMEYes · 277 wordsVignettesYes · 8 · dynamicNEWSYes · 100% structured · mentions 1.1.0Citation fileNoWebsiteYes · pkgdown
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

1.5K
CRAN downloads in the past year
Rank #10,566 · ~4/day · ~123/mo
Daily download trend is not available in this view yet.
34130 days
98090 days
1.5K1 year
Compare downloads with other packages →
Also on21 r2u3 autocran

Repository

59Stars
4Forks
8Open issues
0Open PRs
11Releases
306Commits
5Commit identities
rconvenience-functionsformrsurvey-framework
306 commits · Last activity 2026-10-06 · 0% stars, 30d · Default branch at 1.3.0, ahead of CRAN 1.1.0 (checked 2026-10-21)
Responsiveness
How these are sampled
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

2025-03-05 · 572026-07-07 · 59
PracticesBeta

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.

Continuous integration (2)
GitHub ActionsR CMD check workflow

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

Docs source (3)
pkgdown

GitHub Pages site last deployed 2026-10-06 · The repository has a site deploy workflow

pkgdown site last built 2026-10-06

Coverage (1)
Coverage reporting (Codecov)
CRAN release process (2)
cran-comments.mdCRAN-SUBMISSION
Show all practicesHide 2 practices
Research and citation (1)
Zenodo
Lint, format, editor (1)
RStudio project
How this is detected·Detection ruleset v4 (2026-10-20)
AI coding toolsBeta

This repository shows signs of AI coding tools.

  • Claude Codefirst seen 2026-04-23
    Seen in the repository: CLAUDE.md
    Named in .Rbuildignore: .claude, CLAUDE.md
    Named in .gitignore: .claude
    Pull request it wrote: opened by a project member
    Commits: 3 by its own account · at least 21 crediting it in the message
Models named in its commits
  • 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
Counts are commits, not lines of code. Commits by a tool's accounts count once across all of its accounts. Commits crediting it are the largest count among its credit lines, a minimum.How this is detected·Detection ruleset v4 (updated 2026-09-27)

Dependencies

Declared dependencies
24 external dependencies (excludes base and recommended)

Installing formr adds 74 packages (43 with compiled code, 50 MB of source tarballs). Heaviest: stringi 11 MB, ggplot2 6.0 MB, bslib 5.6 MB.

Depends (1)
R >= 4.1.0
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
0direct
0indirect

Nothing depends on this yet.

People & History

People (2)
Author, Maintainer since 1.1.0 (2026)
Author, Contributor
Releases (1)
  • 1.1.0Latest
    2026-06-16 · current release
  • R
    R 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")
Arslan, R., & Seidel, T. B. (2026). formr: Companion R Package for the 'formr' Survey Framework (Version 1.1.0) [Computer software]. https://doi.org/10.32614/CRAN.package.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.

APA

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

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.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy