Clarify labelled vectors in read docs#800
Open
LeonidasZhak wants to merge 1 commit into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #741.
This updates the
read_*()documentation to make the imported labelled-vector workflow more explicit for users coming from Stata, SPSS, or SAS:labelled()/labelled_spss()intermediate representations, not regular R factorsas_factor()for labelled categorical variableszap_labels()when plain R vectors are needed for analysisI kept this as a documentation-only change and did not add a runtime message, following the maintainer preference in #741.
Checks run locally:
tools::checkRd()forman/read_dta.Rd,man/read_spss.Rd, andman/read_sas.Rdgit diff --checkR CMD build --no-build-vignettes ._R_CHECK_FORCE_SUGGESTS_=false R CMD check --no-manual --ignore-vignettes --no-build-vignettes --no-tests haven_2.5.5.9000.tar.gzThe local machine does not currently have suggested packages
testthatandcovr, so I could not run the full test suite locally. The no-tests check installs the package, checks Rd/examples, and completes with one existing NOTE aboutsetNamesthat is unrelated to this documentation change.