Skip to content

Commit

Permalink
Use more the defaults in package docs + move reexports to a single file
Browse files Browse the repository at this point in the history
  • Loading branch information
olivroy committed Mar 15, 2024
1 parent 85f2737 commit c6144a1
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 17 deletions.
17 changes: 4 additions & 13 deletions R/naniar-package.R
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
#' naniar
#'
#' @description
#' naniar is a package to make it easier to summarise and handle missing values
#' in R. It strives to do this in a way that is as consistent with tidyverse
#' principles as possible. The work is fully discussed at Tierney & Cook (2023)
#' <doi:10.18637/jss.v105.i07>.
#'
#' @name naniar
#' @docType package
#' @seealso [add_any_miss()] [add_label_missings()] [add_label_shadow()] [add_miss_cluster()] [add_n_miss()] [add_prop_miss()] [add_shadow()] [add_shadow_shift()] [as_shadow()] [bind_shadow()] [cast_shadow()] [cast_shadow_shift()] [cast_shadow_shift_label()] [draw_key_missing_point()] [gather_shadow()] [geom_miss_point()] [gg_miss_case()] [gg_miss_case_cumsum()] [gg_miss_fct()] [gg_miss_span()] [gg_miss_var()] [gg_miss_var_cumsum()] [gg_miss_which()] [label_miss_1d()] [label_miss_2d()] [label_missings()] [pct_miss_case()] [prop_miss_case()] [pct_miss_var()] [prop_miss_var()] [pct_complete_case()] [prop_complete_case()] [pct_complete_var()] [prop_complete_var()] [miss_prop_summary()] [miss_case_summary()] [miss_case_table()] [miss_summary()] [miss_var_prop()] [miss_var_run()] [miss_var_span()] [miss_var_summary()] [miss_var_table()] [n_complete()] [n_complete_row()] [n_miss()] [n_miss_row()] [pct_complete()] [pct_miss()] [prop_complete()] [prop_complete_row()] [prop_miss()] [prop_miss_row()] [replace_to_na()] [replace_with_na()] [replace_with_na_all()] [replace_with_na_at()] [replace_with_na_if()] [shadow_shift()] [stat_miss_point()] [vis_miss()] [where_na()]
"_PACKAGE"

#' @import ggplot2
#' @import rlang
NULL

#' @importFrom stats median
#' @importFrom visdat vis_miss
#' @export
visdat::vis_miss

## usethis namespace: start
#' @importFrom lifecycle deprecated
#' @import ggplot2
#' @importFrom stats median
#' @import rlang
## usethis namespace: end
NULL

Expand Down
4 changes: 4 additions & 0 deletions R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ rlang::is_na
#' @export
rlang::are_na

#' @importFrom visdat vis_miss
#' @export
visdat::vis_miss

#' Group By Helper
#'
#' This is a wrapper to facilitate the `grouped_df` S3 method.
Expand Down
10 changes: 8 additions & 2 deletions man/naniar.Rd

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

4 changes: 2 additions & 2 deletions man/reexports.Rd

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

0 comments on commit c6144a1

Please sign in to comment.