Companion R Package for the 'formr' Survey Framework

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.

formr

The accompanying R package for the study framework formr

The formr R package serves as a bridge between the rforms.org survey framework and your R environment. While the package is pre-loaded on the server to handle survey logic, it also provides a suite of tools for your local R workflow.

When used locally (External Usage): These functions streamline the administration and analysis of your study.

• Data Management: Connect to the API to fetch, type-cast, and automatically score results in a single step.
• Project Syncing: Download your study structure (surveys, CSS, assets) to your computer for local editing and version control, then push changes back to the server.

When used within a run (Internal Usage): These functions are designed to run inside rforms.org via OpenCPU to enhance the participant experience.

• Dynamic Feedback: Generate immediate, personalized charts and visualizations to show participants their results.
• Survey Logic: Use shorthand functions to handle complex text logic or conditional display settings within your survey units.

You can get started right here!

Installation

You can install the released version from CRAN:

install.packages("formr")

Or the development version from GitHub:

if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_github("rubenarslan/formr")
library(formr)

Important: API V1 vs. Classic

The package currently supports two workflows.

Documentation

Learn how to get started and how to use the formr package to your advantage:

https://rubenarslan.github.io/formr/