filter_MidPass: filter_MidPass

In vertesy/MarkdownReportsDev: Generate Scientific Figures and Reports Easily

Description

Filter values that fall above high-pass-threshold !(X >= )! and below the low-pass threshold (X <).

Usage

filter_MidPass(
  numeric_vector,
  HP_threshold,
  LP_threshold,
  prepend = "",
  return_survival_ratio = FALSE,
  return_conclusion = FALSE,
  EdgePass = FALSE,
  na.rm = TRUE,
  plot.hist = TRUE,
  saveplot = FALSE,
  ...
)

Arguments

numeric_vector	Values to be filtered.
HP_threshold	Lower threshold value. (>= )
LP_threshold	Upper threshold value. (<)
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
EdgePass	If TRUE, it reverses the filter: everything passes except between the two thresholds.
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_MidPass (numeric_vector = rnorm(1000, 6), HP_threshold = 4,
LP_threshold = 8, prepend = "From all values ", return_survival_ratio = FALSE, EdgePass = TRUE)

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