Replace surveys$id[i] with "SV_xxxxxxx1" to close #341
#360
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
Thank you so much for this PR, @JeffreyRStevens! I don't want to change all these use cases like this based on other feedback and use cases for our docs, but we can definitely add it to the docs for #' # Retrieve a list of surveys
#' surveys <- all_surveys()
#'
#' # Retrieve a single survey using your `surveys` dataframe:
#' my_survey <- fetch_survey(surveyID = surveys$id[6])
#'
#' # Retrieve a single survey if you know the survey ID as a string:
#' my_survey <- fetch_survey(surveyID = "SV_xxxxxxxxxxxxxxx")
#'
#' # Retrieve your survey specifying other args:
#' my_survey <- fetch_survey(
#' surveyID = surveys$id[6],
#' start_date = "2018-01-01",
#' end_date = "2018-01-31",
#' limit = 100,
#' label = TRUE,
#' unanswer_recode = 999,
#' verbose = TRUE,
#' # Manually override EndDate to be a character vector
#' col_types = readr::cols(EndDate = readr::col_character())
#' )Are you interested in updating this PR, or doing a separate one for this change? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses #341 by replacing
surveys$id[i]with"SV_xxxxxxx1"in all documentation. This seems like a more robust way to name the survey ID, since deleting surveys could change a particular survey's position in the list of surveys. Therefore, I made the replacement in all instances in the README, vignette, and examples but describe how to usesurveys$id[i]in the vignette. But I'm happy to alter this, if desired.