predicateFactory-character-numeric-method: Predicate Factory

predicateFactory,character,numeric-methodR Documentation

Predicate Factory

Description

This function creates a predicate function based on a string defining the type of predicate to run and a numeric value. The currently supported types are 'proportionNonZero', 'variance' and 'sd'. The numeric value associated with each predicate type is the threshold for the predicate to be true.

Usage

## S4 method for signature 'character,numeric'
predicateFactory(
  predicateType = c("proportionNonZero", "variance", "sd"),
  threshold = 0.5
)

Arguments

predicateType

string defining the type of predicate to run. The currently supported values are 'proportionNonZero', 'variance' and 'sd'

threshold

numeric value associated with the predicate type

Value

Function returning a boolean indicating if a feature should be included (TRUE) or excluded (FALSE)


VEuPathDB/veupathUtils documentation built on Feb. 8, 2025, 12:29 p.m.