top_curves_to_points.grouped_df: Pull the points from the top (1-alpha)% percent of curves...

In skgallagher/timeternR: A Pipeline to Analyze and Compare Infectious Disease Epidemics

Description

pulling out data points from curves that are ranked highest based on quantile function.

Usage

## S3 method for class 'grouped_df'
top_curves_to_points(
  x,
  alpha,
  tidy_dm,
  quantile_func = distance_depth_function,
  x_names_df = NULL,
  ...
)

Arguments

x	grouped data.frame containing curves, with grouping associated with the rownames of tidy_dm.
alpha	the proportion of curves to be removed before presenting all the points together. Takes value in [0, 1.0].
tidy_dm	a tidy_dist_mat distance matrix
quantile_func	function to calculate quantiles via the distance_matrix, we now expect this function to handle tidy_dist_mat objects and have a parameter called df_out which we can set as true. See distance_depth_function.tidy_dist_mat for an example.
x_names_df	- pointless parameter - is not used.
...	additional parameters to be passed to the quantile_func. Please also see details for more information.

Value

data frame from curves of the top values associated with the quantile_func

skgallagher/timeternR documentation built on Sept. 16, 2021, 7:21 p.m.