single_choice_question_pie: Generates pie charts for single-choice questions.

In lucidviews/repvisForODK: Analyse data from ODK Central

Description

This function generally differentiates between parsing data directly from ODK using the svc option or passing data locally (df or csv). If one provides an svc, the function automatically finds all questions that only received single choices as answers. Please note, that questions which allow multiple choices but only have received single choices are not identified as such. This is because the extended from schema which is provided by the ODK Central API and accessed using ruODK's form_schema_ext does not provide this info. After identifying the questions, the functions also maps the question and choices labels according to their names so that the final plot contains a meaningful title and legend. By default, the function assumes that there is no language differentiation implemented in the form. If so, the argument lang has to be specified accordingly (see parameter description). If svc is set to FALSE and the data is passed locally, the argument qvec has to be specified with the column names of single-choice questions one wants to examine. Please note that for this case the column name will be displayed as the title while the row values will be displayed as the choice labels.

Usage

single_choice_question_pie(
  svc = FALSE,
  df = NULL,
  csv = NULL,
  qvec = NULL,
  lang = NULL,
  df_schema_ext = NULL,
  choice_col = NULL,
  label_col = NULL
)

Arguments

svc	Logical that indicates whether the data shall be parsed using ruODK's odata_submission_get. Optional, defaults to FALSE.
df	Data frame containing the ODK data that is to be used. Optional, defaults to NULL.
csv	Character that specifies the path to the csv file that is to be read. Optional, defaults to NULL.
qvec	Character vector containing the column names of the single-choice questions that is to be examined, defaults to NULL.
lang	Character containing the name of the language that is to be examined, defaults to NULL.
df_schema_ext	Data frame that defines the schema of the from. Can be passed to the function to avoid downloading it multiple times. Optional, defaults to NULL.
choice_col	String specifying the choices column that is to be changed, defaults to NULL.
label_col	String specifying the labels column that is to be changed, defaults to NULL.

Value

List

Examples

## Not run: 
# 1. with SVC
# ruODK needs to be set up for this function to work
repvisforODK::setup_ruODK(svc = example/svc.svc, un = exampleusername, pw = examplepassword, tz = 'Europe/Berlin', verbose = TRUE)

submissions_timeseries_lineplot(svc = TRUE, lang = 'english', choice_col = 'choices_english_(en)', label_col = 'label_english_(en)')

# 2. with data frame and external form schema
df_schema = ruODK::form_schema_ext()

submissions_timeseries_lineplot(df = df_odk_data, lang = 'english', df_schema_ext = df_schema, choice_col = 'choices_english_(en)', label_col = 'label_english_(en)')

# 3. with csv and qvec
submissions_timeseries_lineplot(csv = 'example/file/odk_data.csv', lang = 'english', qvec = c('question1', 'question4'), choice_col = 'choices_english_(en)', label_col = 'label_english_(en)')

## End(Not run)

lucidviews/repvisForODK documentation built on Feb. 13, 2022, 9:50 p.m.