From 3d1c730021022038737368909d3651e5e74b05d1 Mon Sep 17 00:00:00 2001 From: Aaron Ball Date: Thu, 9 Nov 2023 17:47:02 -0700 Subject: [PATCH] added support for filter_id. closes #224 --- R/fetch_survey.R | 6 ++++++ man/fetch_survey.Rd | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/R/fetch_survey.R b/R/fetch_survey.R index 5822832..d1263aa 100644 --- a/R/fetch_survey.R +++ b/R/fetch_survey.R @@ -21,6 +21,9 @@ #' `start_date` and/or `expiration_date` when given Date or string objects #' (see above); ignored when these arguments are given POSIXlt/POSIXct #' objects. +#' @param filter_id String. Unique ID for the response filter created in the +#' Data & Analysis section of the Qualtrics UI. See [Filtering Responses](https://www.qualtrics.com/support/survey-platform/data-and-analysis-module/data/filtering-responses/) for +#' more information. #' @param include_display_order Logical. If `TRUE`, download from surveys using #' block/question/answer display randomization will include contain additional #' variables indicating the randomization pattern used for each case. Defaults @@ -196,6 +199,7 @@ fetch_survey <- start_date = NULL, end_date = NULL, time_zone = NULL, + filter_id = NULL, include_display_order = TRUE, include_metadata = NULL, include_questions = NULL, @@ -255,6 +259,7 @@ fetch_survey <- checkarg_tempdir(tmp_dir) # Check general argument types: + checkarg_ischaracter(filter_id) checkarg_isintegerish(unanswer_recode) checkarg_isintegerish(unanswer_recode_multi) checkarg_isboolean(include_display_order) @@ -276,6 +281,7 @@ fetch_survey <- startDate = start_date_formatted, endDate = end_date_formatted, timeZone = time_zone_formatted, + filterId = filter_id, limit = limit, seenUnansweredRecode = unanswer_recode, multiselectSeenUnansweredRecode = unanswer_recode_multi, diff --git a/man/fetch_survey.Rd b/man/fetch_survey.Rd index 609f5ec..e283ac7 100644 --- a/man/fetch_survey.Rd +++ b/man/fetch_survey.Rd @@ -10,6 +10,7 @@ fetch_survey( start_date = NULL, end_date = NULL, time_zone = NULL, + filter_id = NULL, include_display_order = TRUE, include_metadata = NULL, include_questions = NULL, @@ -54,6 +55,10 @@ timezone (from \code{\link[base:timezones]{base::Sys.timezone()}}). Also applie (see above); ignored when these arguments are given POSIXlt/POSIXct objects.} +\item{filter_id}{String. Unique ID for the response filter created in the +Data & Analysis section of the Qualtrics UI. See \href{https://www.qualtrics.com/support/survey-platform/data-and-analysis-module/data/filtering-responses/}{Filtering Responses} for +more information.} + \item{include_display_order}{Logical. If \code{TRUE}, download from surveys using block/question/answer display randomization will include contain additional variables indicating the randomization pattern used for each case. Defaults