feat: add write_dataset_dictionary()#8
Merged
Merged
Conversation
Adds exported `write_dataset_dictionary()` and internal helper
`.write_file_lines()`. The function writes a knitr::kable() Markdown
table of `create_dataset_dictionary(dataset)` to
`{path}/{dataset_name}_dictionary.md`, intended as a hand-editable
bootstrap step in the dictionary workflow.
- Closes #4
There was a problem hiding this comment.
Pull request overview
This PR implements the write_dataset_dictionary() exported function (closing issue #4), which bootstraps a Markdown data dictionary file for a dataset. It also adds the internal helper .write_file_lines(). Together these form the primary interactive entry point for the dictionary workflow, outputting a knitr::kable() table to {path}/{dataset_name}_dictionary.md for hand-editing.
Changes:
- Adds
R/write_dataset_dictionary.Rwithwrite_dataset_dictionary()and.write_file_lines(). - Adds full test coverage in
tests/testthat/test-write_dataset_dictionary.R, and removes redundantskip_if_not_installedguards fromtest-describe_dataset.R. - Updates
DESCRIPTION,NAMESPACE, andman/with the new function, its internal helper, and new dependencies (knitr,rlangin Imports;usethisin Suggests).
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
R/write_dataset_dictionary.R |
New file: implements write_dataset_dictionary() and .write_file_lines() |
tests/testthat/test-write_dataset_dictionary.R |
New test file: full coverage for both new functions |
tests/testthat/test-describe_dataset.R |
Removes redundant skip_if_not_installed guards for Imports packages |
man/write_dataset_dictionary.Rd |
Generated Rd for the new exported function |
man/dot-write_file_lines.Rd |
Generated Rd for the new internal helper |
NAMESPACE |
Exports write_dataset_dictionary |
DESCRIPTION |
Adds knitr and rlang to Imports; usethis and withr to Suggests |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Copilot AI
added a commit
that referenced
this pull request
Mar 9, 2026
Co-authored-by: jonthegeek <33983824+jonthegeek@users.noreply.github.com>
jonthegeek
added a commit
that referenced
this pull request
Mar 9, 2026
* Initial plan * docs: adapt AGENTS.md and skills from tibblify (#8) Co-authored-by: jonthegeek <33983824+jonthegeek@users.noreply.github.com> * Tweaks from tibblify versions. * fix: copilot suggestions Use more realistic example. Remove irrelevant integration test example. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jonthegeek <33983824+jonthegeek@users.noreply.github.com> Co-authored-by: Jon Harmon <jonthegeek@gmail.com>
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.
Adds exported
write_dataset_dictionary()and internal helper.write_file_lines(). The function writes a knitr::kable() Markdown table ofcreate_dataset_dictionary(dataset)to{path}/{dataset_name}_dictionary.md, intended as a hand-editable bootstrap step in the dictionary workflow.