exclude_location | R Documentation |
The exclude_location()
function removes
rows that have locations outside of the US.
The function is written to work with data from
Qualtrics surveys.
exclude_location( x, id_col = "ResponseId", location_col = c("LocationLatitude", "LocationLongitude"), rename = TRUE, include_na = FALSE, quiet = TRUE, print = TRUE, silent = FALSE )
x |
Data frame (preferably imported from Qualtrics using {qualtRics}). |
id_col |
Column name for unique row ID (e.g., participant). |
location_col |
Two element vector specifying columns for latitude and longitude (in that order). |
rename |
Logical indicating whether to rename columns (using |
include_na |
Logical indicating whether to include rows with NA in latitude and longitude columns in the output list of potentially excluded data. |
quiet |
Logical indicating whether to print message to console. |
print |
Logical indicating whether to print returned tibble to console. |
silent |
Logical indicating whether to print message to console. Note this argument controls the exclude message not the check message. |
To record this information in your Qualtrics survey, you must ensure that Anonymize responses is disabled.
Default column names are set based on output from the
qualtRics::fetch_survey()
.
The function only works for the United States.
It uses the #' maps::map.where()
to determine if latitude and longitude
are inside the US.
The function outputs to console a message about the number of rows with locations outside of the US.
An object of the same type as x
that excludes rows
that are located outside of the US and (if include_na == FALSE
) rows with
no location information.
For a function that checks for these rows, use check_location()
.
For a function that marks these rows, use mark_location()
.
Other location functions:
check_location()
,
mark_location()
Other exclude functions:
exclude_duplicates()
,
exclude_duration()
,
exclude_ip()
,
exclude_preview()
,
exclude_progress()
,
exclude_resolution()
# Exclude locations outside of the US data(qualtrics_text) df <- exclude_location(qualtrics_text) # Remove preview data first df <- qualtrics_text %>% exclude_preview() %>% exclude_location()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.