check_preview {excluder}

Check for survey previews

Description

The check_preview() function subsets rows of data, retaining rows that are survey previews. The function is written to work with data from Qualtrics surveys.

Usage

check_preview(
  x,
  id_col = "ResponseId",
  preview_col = "Status",
  rename = TRUE,
  keep = FALSE,
  quiet = FALSE,
  print = TRUE
)

Arguments

x

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

id_col

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

preview_col

Column name for survey preview.

rename

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

keep

Logical indicating whether to keep or remove exclusion column.

quiet

Logical indicating whether to print message to console.

print

Logical indicating whether to print returned tibble to console.

Details

Default column names are set based on output from the qualtRics::fetch_survey(). The preview 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 are survey previews.

Value

The output is a data frame of the rows that are survey previews. For a function that marks these rows, use mark_preview(). For a function that excludes these rows, use exclude_preview().

See Also

Other preview functions: exclude_preview(), mark_preview()

Other check functions: check_duplicates(), check_duration(), check_ip(), check_location(), check_progress(), check_resolution()

Examples

# Check for survey previews
data(qualtrics_text)
check_preview(qualtrics_text)

# Works for Qualtrics data exported as numeric values, too
qualtrics_numeric %>%
  check_preview()

# Do not print rows to console
qualtrics_text %>%
  check_preview(print = FALSE)

# Do not print message to console
qualtrics_text %>%
  check_preview(quiet = TRUE)