docs: document retained metadata for read_xpt/write_xpt (#719)#801
Closed
LeonidasZhak wants to merge 3 commits into
Closed
docs: document retained metadata for read_xpt/write_xpt (#719)#801LeonidasZhak wants to merge 3 commits into
LeonidasZhak wants to merge 3 commits into
Conversation
- Add format.sas round-trip documentation to read_xpt @return - Document that value labels are not supported by XPT format - Add round-trip example showing label and format.sas preservation - Update NEWS.md with XPT metadata documentation entry
PR tidyverse#801 updated R/haven-sas.R with format.sas and notes documentation for read_sas() but did not regenerate the corresponding Rd file.
…S metadata docs - Fix read_xpt round-trip example: use 'BEST12' without trailing period (ReadStat strips trailing periods from XPT format names) - Add note about format.sas trailing period behavior to read_xpt docs - Add format.stata and notes docs to read_dta - Add format.spss, display_width, na_values/na_range, notes docs to read_spss - Regenerate read_xpt.Rd, read_dta.Rd, read_spss.Rd from roxygen source
This was referenced Jun 6, 2026
Author
|
I am withdrawing this PR as part of a broader cleanup of an oversized automated contribution batch. I am sorry for the review noise and the pressure this may have put on maintainers. Going forward I will keep contributions to this project much more limited and higher-signal, ideally only one or two focused PRs at a time. Thank you for maintaining the project. |
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
1 participant
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.
Addresses #719.
Documents the metadata retained by
read_xpt()and used bywrite_xpt()for round-tripping:format.sas: Documents that the original SAS variable format is stored asformat.sasand thatwrite_xpt()reads it back to preserve the format during round-trips.read_xpt()and silently ignored bywrite_xpt()).labelandformat.sassurvive awrite_xpt()→read_xpt()cycle.notesattribute for completeness.This is a documentation-only change to
R/haven-sas.R,man/read_xpt.Rd, andNEWS.md. Complements the existingread_sas/read_dta/read_spssmetadata docs.Relation to #800: PR #800 documents the
labelled()class and value label workflow forread_sas/read_dta/read_spss. This PR focuses on the XPT-specific metadata that #800 does not cover. No overlap.Checks run locally:
tools::checkRd("man/read_xpt.Rd")— cleanR CMD build --no-build-vignettes .— clean_R_CHECK_FORCE_SUGGESTS_=false R CMD check --no-manual --ignore-vignettes --no-build-vignettes --no-tests haven_2.5.5.9000.tar.gz— 1 pre-existing NOTE (setNamesin NAMESPACE), unrelated to this change