cvFilter-methods {xps} | R Documentation

## Coefficient of Variation Filter

### Description

This method initializes the Coefficient of Variation Filter.
The coefficient of variation is the standard deviation divided by the absolute value of the mean.
The CV Filter flags all rows with: `flag = (cv >= cutoff)`

Usage

| `cvFilter(object)`
| `cvFilter(object, value)<-`

### Arguments

`object` | object of class `PreFilter`.
`value` | numeric vector `c(cutoff, trim, epsilon)`.

### Details

The method `cvFilter` initializes the following parameters:

| `cutoff`: | the cutoff level for the filter.
| `trim`: | the trim value for trimmed mean (default is `trim=0`).
| `epsilon`: | value to replace mean (default is `epsilon=0.01`):
|  | `epsilon > 0`: replace mean=0 with epsilon.
|  | `epsilon = 0`: always set mean=1.

Note, that for `epsilon = 0` the filter flags all rows with: stdev >= cutoff

### Value

An initialized `PreFilter` object.

### Author(s)

Christian Stratowa

### Examples

    prefltr <- PreFilter()
    cvFilter(prefltr) <- c(0.3,0.0,0.01)
    str(prefltr)

[Package xps version 1.0.2 Index]