Add docs for xportr()
Task list completed / task-list-completed
Started
2024-01-08 17:23:33
ago
2 / 14 tasks completed
12 tasks still to be completed
Details
Required Tasks
| Task | Status |
|---|---|
| Add a top-level function that applies all other functions and writes XPT | Incomplete |
| The spirit of xportr is met in your Pull Request | Incomplete |
| Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update) | Completed |
| Summary of changes filled out in the above Changes Description. Can be removed or left blank if changes are minor/self-explanatory. | Completed |
Code is formatted according to the tidyverse style guide. Use styler package and functions to style files accordingly. |
Incomplete |
| Updated relevant unit tests or have written new unit tests. See our Wiki for conventions used in this package. | Incomplete |
| Creation/updated relevant roxygen headers and examples. See our Wiki for conventions used in this package. | Incomplete |
Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately |
Incomplete |
Run pkgdown::build_site() and check that all affected examples are displayed correctly and that all new/updated functions occur on the "Reference" page. |
Incomplete |
| Update NEWS.md if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers) | Incomplete |
Make sure that the pacakge version in the NEWS.md and DESCRIPTION file is same. Don't worry about updating the version because it will be auto-updated using the vbump.yaml CI. |
Incomplete |
| Address any updates needed for vignettes and/or templates | Incomplete |
| Link the issue Development Panel so that it closes after successful merging. | Incomplete |
| Fix merge conflicts | Incomplete |
| Pat yourself on the back for a job well done! Much love to your accomplishment! | Incomplete |
inspired by {dm} which handles metadata and has a naming structure similar to xportr with dm_*() function names as well as dm() |
Incomplete |
xportr_all() |
Incomplete |
inspired by {dm} which handles metadata and has a naming structure similar to xportr with dm_*() function names as well as dm() |
Incomplete |
xportr_all() |
Incomplete |
Loading