export(type_density)

importFrom(stats,bw.SJ)

importFrom(stats,bw.bcv)

importFrom(stats,bw.nrd)

importFrom(stats,bw.nrd0)

importFrom(stats,bw.ucv)

importFrom(stats,weighted.mean)

user-facing. Related updates are grouped below for easier navigation.

New plot `type` processing system (#222 @vincentarelbundock):

- In addition to the standard character labels (e.g., `"p"`, `"density"`), the

`type` argument now supports _functional_ equivalents (e.g., `type_points()`,

`type_density()`. These new functional types all take the form `type_*()`.

- The character and functional types are interchangeable. For example,

`tinyplot(Nile, type = "hist")` and `tinyplot(Nile, type = type_hist())`

produce exactly the same result.

- The main advantage of the functional `type_*()` variants is that they offer

much more flexibility and control beyond the default case(s). Users can pass

appropriate arguments to existing types for customization and can even define

their own `type_<typename>()` functions.

- On the development side, overhauling the `type` system has also allowed us to

introduce a number of new plot types and features (see list below). We have

also simplified our internal codebase, since explicit argument passing

requires less guesswork on our end.

- Speaking of which, we now recommended that users explicitly pass ancillary

type-specific arguments as part of the relevant `type_*()` call. For example:

`tinyplot(Nile, type = type_hist(breaks = 30))` is preferable to

`tinyplot(Nile, type = "hist", breaks = 30)`. While the latter option will

still work in this particular case, we cannot guarantee that it will for other

cases. (Reason: Passing ancillary type-specific arguments at the top level of

the plot call only works if these do not conflict with the main arguments of

the `tinyplot()` function itself; see #267.)

- Some minor breaking changes were unavoidable; see further below.

- For more details on the new `type` system, please see the dedicated

Breaking changes:

- There are a few breaking changes to grouped density plots. (#284 @grantmcdermott)

- The default smoothing bandwidth is now computed independently for each data

subgroup, rather than being computed from the joint density. Users can still

opt into using a joint bandwidth by invoking the

`type_density(joint.bw = <option>)` argument. See the function documentation

for details.

- Grouped and/or faceted plots are no longer possible on density objects

(i.e., via the `tinyplot.density()` method). Instead, please rather call

`tinyplot(..., type = "density")` or `tinyplot(..., type = type_density())`

on the raw data and pass grouping or facet arguments as needed.

- The `ribbon.alpha` argument in `tinyplot()` has been deprecated. Use the

`alpha` argument in `type_ribbon()` (and equivalents) instead: e.g.,

`tinyplot(..., type = type_ribbon(alpha = 0.5))`.

- Aside: Please note that this is _not_ equivalent to using

`tinyplot(..., type = "ribbon", alpha = 0.5)` because the latter matches the

top-level `alpha` argument of `tinyplot()` itself (and thus modifies the

entire `palette`, rather than just the ribbon). See our warning about passing

ancillary type-specific arguments above.

"density" = type_density,

# retrieve type-specific data and drawing functions

# area flag (mostly for legend)

} else if (type == "density") {

if (is.null(ylab)) ylab = "Density"

} else if (type %in% c("histogram", "function")) {

if (is.null(ylab)) ylab = "Frequency"

} else {

dens_type = (is.atomic(type) && identical(type, "density")) || (!is.atomic(type) && identical(type$name, "density"))

if (!is.null(type) && dens_type) {

if (is.null(ylab)) ylab = "Density"

if (is.null(xlab)) xlab = xnam

} else if (!is.null(type) && hist_type) {

tinyplot.density = function(

x = NULL,

type = c("l", "area"),

...) {

dots = list(...)

if (!is.null(dots[["by"]]) || !is.null(dots[["facet"]])) {

stop(

'\nGrouped and/or faceted plots are no longer supported with the tinyplot.density() method. ',

'\nPlease use the dedicated type argument instead, e.g. `tinyplot(..., type = "density")`. See `?type_density` for details.',

'\n\nThis breaking change was introduced in tinyplot v0.3.0.'

)

}

type = match.arg(type)

## override if bg = "by"

if (!is.null(dots[["bg"]]) || !is.null(dots[["fill"]])) type = "area"

if (inherits(x, "density")) {

object = x

# legend_args = list(x = NULL)

# # Grab by label to pass on legend title to tinyplot.default

# legend_args[["title"]] = deparse(substitute(by))

} else {

## An internal catch for non-density objects that were forcibly

## passed to tinyplot.density (e.g., via a one-side formula)

if (anyNA(x)) {

x = na.omit(x)

x = as.numeric(x)

}

object = density(x)

}

x = object$x

y = object$y

if (type == "area") {

ymin = rep(0, length(y))

ymax = y

# # set extra legend params to get bordered boxes with fill

# legend_args[["x.intersp"]] = 1.25

# legend_args[["lty"]] = 0

# legend_args[["pt.lwd"]] = 1

}

# splice in change arguments

dots[["x"]] = x

dots[["y"]] = y

dots[["type"]] = type

## axes range

if (is.null(dots[["xlim"]])) dots[["xlim"]] = range(x)

if (is.null(dots[["ylim"]])) dots[["ylim"]] = range(y)

## nice labels and titles

if (is.null(dots[["ylab"]])) dots[["ylab"]] = "Density"

if (is.null(dots[["xlab"]])) dots[["xlab"]] = paste0("N = ", object$n, " Bandwidth = ", sprintf("%.4g", object$bw))

if (is.null(dots[["main"]])) dots[["main"]] = paste0(paste(object$call, collapse = "(x = "), ")")

do.call(tinyplot.default, args = dots)

}

type_area = function(alpha = NULL) {

data = data_area(alpha = alpha),

data_area = function(alpha = alpha) {

ribbon.alpha = if (is.null(alpha)) .tpar[["ribbon.alpha"]] else (alpha)

type = "ribbon",

ribbon.alpha = ribbon.alpha