Skip to content

Commit

Permalink
Tweak help titles
Browse files Browse the repository at this point in the history
  • Loading branch information
hughjonesd committed Jun 10, 2024
1 parent 28693ac commit 6d262cc
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
3 changes: 2 additions & 1 deletion R/chop-by-group-size.R
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
#' emitted. Set `recalc_probs = TRUE` to recalculate the probabilities of the quantiles
#' using the [empirical cumulative distribution function][stats::ecdf()] of `x`.
#' Doing so may give you different labels from what you expect, and will
#' remove any names from `probs`. See the example below.
#' remove any names from `probs`. At present, `recalc_probs = TRUE` is incompatible
#' with non-null `weights`. See the example below.
#'
#' @family chopping functions
#'
Expand Down
11 changes: 5 additions & 6 deletions R/chop-isolates.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

#' Chop common values into separate categories
#' Chop common values into singleton intervals
#'
#' `chop_spikes()` lets you isolate common values of `x` in their own
#' `chop_spikes()` lets you chop common values of `x` into their own
#' singleton intervals. This can help make unusual values visible.
#'
#' This function is `r lifecycle::badge("experimental")`.
Expand Down Expand Up @@ -40,16 +40,15 @@ chop_spikes <- function (
}


#' Cut data into intervals, isolating common elements
#' Cut data into intervals, then separate out common values
#'
#' Sometimes it's useful to separate out common elements of `x`.
#' `dissect()` first chops `x`, then puts common elements of `x` ("spikes")
#' into separate categories.
#'
#' Unlike [chop_spikes()], `dissect()` doesn't break up
#' intervals which contain a spike. As a result, unlike other `chop_*` functions,
#' `dissect()` does not typically chop `x` into disjoint intervals. See
#' the examples.
#' `dissect()` does not chop `x` into disjoint intervals. See the examples.
#'
#' If breaks are data-dependent, their labels may be misleading after common
#' elements have been removed. See the example below.
Expand Down Expand Up @@ -151,4 +150,4 @@ find_spikes <- function (x, n, prop) {
spikes <- spikes[! is.na(spikes)]

spikes
}
}
3 changes: 2 additions & 1 deletion man/chop_quantiles.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/chop_spikes.Rd

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

5 changes: 2 additions & 3 deletions man/dissect.Rd

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

0 comments on commit 6d262cc

Please sign in to comment.