filter_HP: filter_HP

In vertesy/MarkdownReportsDev: Generate Scientific Figures and Reports Easily

Description

Filter values that fall between above high-pass-threshold (X >).

Usage

filter_HP(
  numeric_vector,
  threshold,
  passequal = FALSE,
  prepend = "",
  return_survival_ratio = FALSE,
  return_conclusion = FALSE,
  na.rm = TRUE,
  plot.hist = TRUE,
  saveplot = FALSE,
  ...
)

Arguments

numeric_vector	Values to be filtered.
threshold	A numeric value above which "numeric_vector" passes.
passequal	Pass if a value is larger, or equal than the threshold. FALSE by default.
prepend	Text prepended to the results.
return_survival_ratio	Return a number with the survival ratio (TRUE). or a logical index vector of the survivors (FALSE). return_conclusion must be FALSE
return_conclusion	Return conclusion sentence that (also printed). return_survival_ratio must be FALSE
na.rm	Remove NA-s? Default: TRUE
plot.hist	Plot the histogram of the input data
saveplot	Save the histogram as PDF, FALSE by defeault
...	Additional arguments for the histogram

Examples

filter_HP (numeric_vector = rnorm(1000, 6), threshold = 5,
 prepend = "From all values ", return_survival_ratio = FALSE)

vertesy/MarkdownReportsDev documentation built on Nov. 15, 2021, 9:59 a.m.