Skip to contents

Mark survey progress

Source: R/progress.R
mark_progress.Rd

The mark_progress() function creates a column labeling rows that have incomplete progress. The function is written to work with data from Qualtrics surveys.

Usage

mark_progress(
  x,
  min_progress = 100,
  id_col = "ResponseId",
  finished_col = "Finished",
  progress_col = "Progress",
  rename = TRUE,
  quiet = FALSE,
  print = TRUE
)

Arguments

x

Data frame (preferably imported from Qualtrics using {qualtRics}).

min_progress

Amount of progress considered acceptable to include.

id_col

Column name for unique row ID (e.g., participant).

finished_col

Column name for whether survey was completed.

progress_col

Column name for percentage of survey completed.

rename

Logical indicating whether to rename columns (using rename_columns())

quiet

Logical indicating whether to print message to console.

print

Logical indicating whether to print returned tibble to console.

Value

An object of the same type as x that includes a column marking rows that have incomplete progress. For a function that checks for these rows, use check_progress(). For a function that excludes these rows, use exclude_progress().

Details

Default column names are set based on output from the qualtRics::fetch_survey(). The default requires 100% completion, but lower levels of completion maybe acceptable and can be allowed by specifying the min_progress argument. The finished column in Qualtrics can be a numeric or character vector depending on whether it is exported as choice text or numeric values. This function works for both.

The function outputs to console a message about the number of rows that have incomplete progress.

See also

Other progress functions: check_progress(), exclude_progress()

Other mark functions: mark_duplicates(), mark_duration(), mark_ip(), mark_location(), mark_preview(), mark_resolution()

Examples

# Mark rows with incomplete progress
data(qualtrics_text)
df <- mark_progress(qualtrics_text)
#> ℹ 6 out of 100 rows did not complete the study.

# Remove preview data first
df <- qualtrics_text %>%
  exclude_preview() %>%
  mark_progress()
#> ℹ 2 out of 100 preview rows were excluded, leaving 98 rows.
#> ℹ 6 out of 98 rows did not complete the study.

# Include a lower acceptable completion percentage
df <- qualtrics_numeric %>%
  exclude_preview() %>%
  mark_progress(min_progress = 98)
#> ℹ 2 out of 100 preview rows were excluded, leaving 98 rows.
#> ℹ 6 rows did not complete the study, and 5 of those completed less than 98% of the study.