outlier_filter {ISAnalytics}R Documentation

Filter out outliers in metadata, identified by the chosen outlier test.

Description

[Experimental] Filter out outliers in metadata.

Usage

outlier_filter(
  metadata,
  outlier_test = "outliers_by_pool_fragments",
  negate = FALSE,
  ...
)

Arguments

metadata

The metadata data frame

outlier_test

A string representing a function name. The name must be one of the available outlier tests, see available_outlier_tests.

negate

If TRUE will return only the metadata that was flagged to be removed. If FALSE will return only the metadata that wasn't flagged to be removed.

...

Additional named arguments passed to outliers_test

Value

A data frame of metadata which has less or the same amount of rows

Examples

data("association_file", package = "ISAnalytics")
filtered_af <- outlier_filter(association_file,
    key = "BARCODE_MUX",
    report_path = NULL
)
head(filtered_af)

[Package ISAnalytics version 1.4.2 Index]