Companion R Package for the 'formr' Survey Framework

Documentation for package ‘formr’ version 1.1.0

Help Pages

-- A --

aggregate_and_document_scale	Aggregate variables and remember which variables this were
as.data.frame.formr_api_run_structure	Convert formr run structure to data.frame
as.data.frame.formr_item_list	Transform formr_item_list into a data.frame for ease of use
asis_knit_child	knit_child as is

-- C --

choice_labels_for_values	switch choice values with labels
current	Gives the last element, doesn't omit missings

-- E --

email_image	generates valid email cids
expired	How many surveys were expired?

-- F --

feedback_chunk	Text feedback based on groups
finished	How many surveys were finished?
first	Gives the first non-missing element
formr_aggregate	Aggregate data based on item table
formr_api_aggregate	Aggregate Scales
formr_api_authenticate	Authenticate with formr
formr_api_backup_run	Backup a study
formr_api_create_run	Create a new run
formr_api_create_session	Create Session(s)
formr_api_delete_all_files	Delete ALL files attached to a run
formr_api_delete_file	Delete file(s) from a run
formr_api_delete_run	Delete a Run
formr_api_delete_survey	Delete a Survey
formr_api_fetch_results	Lower-level API Result Fetcher
formr_api_files	List files attached to a run
formr_api_is_authenticated	Check if currently authenticated
formr_api_logout	Revoke Access Token (Logout)
formr_api_pull_project	Pull Project from Server Scaffolds folder structure if missing, then overwrites local files with Server state.
formr_api_push_project	Push Project to Server
formr_api_recognise	Apply Type Definitions and Labels
formr_api_results	Get and Process Run Results
formr_api_reverse	Reverse Items and Update Labels
formr_api_runs	List all runs
formr_api_run_settings	Get or Update Run Settings
formr_api_run_structure	Get or Update Run Structure (Run Units)
formr_api_session	Get Current API session
formr_api_sessions	List Sessions in a Run
formr_api_session_action	Perform Action on Session(s)
formr_api_surveys	List Surveys
formr_api_survey_structure	Get Survey Structure (Items)
formr_api_token_expiry	Get token expiry information
formr_api_unit_sessions	List Per-Unit Sessions in a Run
formr_api_upload_file	Upload File(s) to Run
formr_api_upload_survey	Upload/Update Survey
formr_backup_files	Backup uploaded files from formr
formr_backup_study	Backup a study
formr_backup_surveys	Backup surveys
formr_connect	Connect to formr
formr_default_dir	Get or set the default directory for downloads and backups
formr_disconnect	Disconnect from formr
formr_inline_render	render inline text for formr
formr_items	Download items from formr
formr_item_displays	Download detailed result timings and display counts from formr
formr_knit	knit rmarkdown to markdown for formr
formr_last_host	Get the last specified host
formr_overview_sankey	Render a participant-flow Sankey for an overview script
formr_post_process_results	Processed, aggregated results
formr_raw_results	Download data from formr
formr_recognise	Recognise data types based on item table
formr_render	render text for formr
formr_render_commonmark	render inline text for formr
formr_results	Download processed, aggregated results from formr
formr_reverse	Reverse items based on item table or a fallback_max
formr_run_structure	Download run structure from formr
formr_shuffled	Download random groups
formr_simulate_from_items	Simulate data based on item table
formr_store_keys	Store Credentials in Keyring
formr_uploaded_files	Download uploaded files from formr
formr_upload_items	Upload new item table
formr_user_detail	Download random groups
formr_user_overview	Download random groups

-- G --

get_opencpu_rds

pass in the url to the RDS representation of a openCPU session object, get the object

-- I --

ifelsena	Like 'ifelse()', but allows you to assign a third value to missings.
if_na	Replace NA values with something else
if_na_null	This function makes sure you know what to expect when evaluating uncertain results in an if-clause. In most cases, you should not use this function, because it can lump a lot of very different cases together, but it may have some use for fool-proofing certain if-clauses on rforms.org, where a field in a survey may either not exist, be missing or have a value to check.
in_time_window	checks whether the current time is in a certain time window
item	get item from survey attribute
items	get item list from survey attributes

-- K --

knit_prefixed

knit prefixed

-- L --

last	Gives the last non-missing element

-- M --

markdown_custom_options	custom markdown options for rmarkdown's pandoc
markdown_github	github_markdown for rmarkdown
markdown_hard_line_breaks	hard line breaks

-- N --

next_day

checks whether a new day has broken (date has increased by at least one day)

-- P --

paste.knit_asis	paste.knit_asis
print.formr_api_run_structure	Print method for formr run structure
print.knit_asis	Print new lines in knit_asis outputs

-- Q --

qplot_on_bar	Plot normed values as a barchart
qplot_on_normal	Plot a normed value on the standard normal
qplot_on_polar	Time-polar plot

-- R --

random_date_in_range	Random date in range
render_text	render text
rescue_attributes	Rescue lost attributes
reverse_labelled_values	Reverse labelled values

-- S --

summary.formr_results

Summarize Processing History

-- T --

text_message_clickatell	Send text message via Clickatell
text_message_massenversand	Send text message via Massenversand.de
text_message_twilio	Send text message via Twilio
time_passed	checks how much time has passed relative to the user's last action

-- W --

word_document

word_document from rmarkdown, but has an added option not to break on error

-- misc --

%begins_with%	check whether a character string begins with a string
%contains%	check whether a character string contains another
%contains_word%	check whether a character string contains another as a word
%ends_with%	check whether a character string ends with a string
%starts_with%	check whether a character string begins with a string
.formr	Per-request environment populated by rforms.org