Skip to content

Commit

Permalink
docs: make some minor document related changes
Browse files Browse the repository at this point in the history
* Remove the argument verbose from the xportr_format() function calls in examples
* Removes the warning when trying to build the pkgdown site by having consistent VignetteIndexEntry name for “Getting Started”
* Minor format changes to the NEWS.md
* Lint the _pkgdown configuration
  • Loading branch information
vedhav committed Jun 19, 2023
1 parent 7dcf325 commit 852ca17
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 14 deletions.
9 changes: 4 additions & 5 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* Fixed messaging of `xportr_order()`to give better visibility of the number of variables being reordered.
* Add new argument to `xportr_write()` to allow users to specify how xpt validation checks are handled.
* Fixed bug where character_types were case sensitive. They are now case insensitive (#77).
* Updated `xportr_type()` to make type coercion more explicit.
* Updated `xportr_type()` to make type coercion more explicit.
* `xpt_validate` updated to accept iso8601 date formats. (#76)
* Added function `xportr_metadata()` to explicitly set metadata at the start of a pipeline (#44)
* Metadata order columns are now coerced to numeric by default in `xportr_order()` to prevent character sorting (#149)
Expand All @@ -22,8 +22,7 @@
* Get Started vignette spruced up. Messages are now displayed and link to Deep Dive vignette (#150)
* Increase test coverage to 100% (#82)

## Deprecation
and Breaking Changes
## Deprecation and Breaking Changes

* The `metacore` argument has been renamed to `metadata` in the following six xportr functions: `xportr_df_label()`, `xportr_format()`, `xportr_label()`, `xportr_length()`, `xportr_order()`, and `xportr_type()`. Please update your code to use the new `metadata` argument in place of `metacore`.

Expand All @@ -34,9 +33,9 @@ and Breaking Changes

# xportr 0.1.0

Beta release for xportr
Beta release for xportr

* Added exported functions `xportr_varnames` and `xportr_tidy_rename` into `dev` folder found on GitHub Repostiory. Intention to move into packages after CRAN release.
* Added exported functions `xportr_varnames` and `xportr_tidy_rename` into `dev` folder found on GitHub Repostiory. Intention to move into packages after CRAN release.
* Fixed xportr_format() bug
* Using admiral ADSL dataset in examples

Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ adsl %>%
xportr_length(var_spec, "ADSL", verbose = "warn") %>%
xportr_label(var_spec, "ADSL", verbose = "warn") %>%
xportr_order(var_spec, "ADSL", verbose = "warn") %>%
xportr_format(var_spec, "ADSL", verbose = "warn") %>%
xportr_format(var_spec, "ADSL") %>%
xportr_write("adsl.xpt", label = "Subject-Level Analysis Dataset")
```

Expand Down
4 changes: 1 addition & 3 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ navbar:
aria-label: slack

reference:
- title: Core xportr functions
- title: Core xportr functions
- contents:
- xportr_type
- xportr_length
Expand All @@ -40,7 +40,6 @@ reference:
- var_ord_msg
- xportr_logger


- title: xportr example datasets and specification files
- contents:
- adsl
Expand All @@ -51,4 +50,3 @@ articles:
navbar: ~
contents:
- deepdive

7 changes: 4 additions & 3 deletions man/xportr_write.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/deepdive.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ adsl %>%
xportr_length(var_spec, "ADSL", "message") %>%
xportr_label(var_spec, "ADSL", "message") %>%
xportr_order(var_spec, "ADSL", "message") %>%
xportr_format(var_spec, "ADSL", "message") %>%
xportr_format(var_spec, "ADSL") %>%
xportr_write("adsl.xpt", label = "Subject-Level Analysis Dataset")
```

Expand Down
2 changes: 1 addition & 1 deletion vignettes/xportr.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ output:
toc: true
check_title: TRUE
vignette: >
%\VignetteIndexEntry{xportr}
%\VignetteIndexEntry{Getting Started}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
Expand Down

0 comments on commit 852ca17

Please sign in to comment.