Preparations for the release (#340)

This PR have some preparations for the release (related to #339)



**What changes are proposed in this pull request?**

* Help pages were updated with roxygen2 v8.0.0 and made them pass
`devtools::check_doc_fields()` .
 
The check resulted on deleting the help pages of the packages (but keep
the roxygen2 documentation) and adding some fields on the deprecated.Rd
file.

Provide more detail here as needed.

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#<issue number>'_



--------------------------------------------------------------------------------

Pre-review Checklist (if item does not apply, mark is as complete)
- [x] **All** GitHub Action workflows pass with a ✅
- [x] PR branch has pulled the most recent updates from master branch:
`usethis::pr_merge_main()`
- [x] If a bug was fixed, a unit test was added.
- [x] If a new `ard_*()` function was added, it passes the ARD
structural checks from `cards::check_ard_structure()`.
- [x] If a new `ard_*()` function was added, `set_cli_abort_call()` has
been set.
- [x] If a new `ard_*()` function was added and it depends on another
package (such as, `broom`), `is_pkg_installed("broom")` has been set in
the function call and the following added to the roxygen comments:
`@examplesIf do.call(asNamespace("cardx")$is_pkg_installed, list(pkg =
"broom""))`
- [x] Code coverage is suitable for any new functions/features
(generally, 100% coverage for new code): `devtools::test_coverage()`

Reviewer Checklist (if item does not apply, mark is as complete)

- [ ] If a bug was fixed, a unit test was added.
- [ ] Code coverage is suitable for any new functions/features:
`devtools::test_coverage()`

When the branch is ready to be merged:
- [ ] Update `NEWS.md` with the changes from this pull request under the
heading "`# cardx (development version)`". If there is an issue
associated with the pull request, reference it in parentheses at the end
update (see `NEWS.md` for examples).
- [ ] **All** GitHub Action workflows pass with a ✅
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge" or "Rebase and merge".

---------

Co-authored-by: Daniel Sjoberg <danield.sjoberg@gmail.com>

Author: llrs-roche

R/ard_aod_wald_test.R

@@ -109,6 +109,9 @@ ard_aod_wald_test <- function(x, tidy_fun = broom.helpers::tidy_with_broom_or_pa
 #' @param wald_test (`data.frame`)\cr wald test object object from `aod::wald.test()`
 #'
 #' @return a data frame containing the wald test results.
+#' @examples
+#' NULL
+#'
 #' @keywords internal
 .extract_wald_results <- function(wald_test) {
   df <- wald_test$result$chi2[("df")]

R/ard_stats_prop_test.R

@@ -98,6 +98,9 @@ ard_stats_prop_test <- function(data, by, variables, conf.level = 0.95, ...) {
 #' @param ... passed to `prop.test(...)`
 #'
 #' @return ARD data frame
+#' @examples
+#' NULL
+#'
 #' @keywords internal
 .format_proptest_results <- function(by, variable, lst_tidy, ...) {
   # build ARD ------------------------------------------------------------------

R/deprecated.R

@@ -7,6 +7,10 @@
 #'
 #' @name deprecated
 #' @keywords internal
+#' @examples
+#' NULL
+#' @returns See each individual function help page.
+#'
 NULL
 
 # v0.3.0 -----------------------------------------------------------------------