Matched-class {nullranges} | R Documentation

## Matched objects

### Description

The Matched class is a container for attributes of covariate-matched data resulting from `matchRanges()`.

### Slots

`matchedData`

  A `data.table` with matched data

`matchedIndex`

  An integer vector corresponding to the indices in the `pool` which comprise the `matched` set.

`covar`

  A character vector describing the covariates used for matching.

`method`

  Character describing replacement method used for matching.

`replace`

  TRUE/FALSE describing if matching was done with or without replacement.

### Accessor methods for Matched Class

Functions that get data from Matched subclasses (`x`) such as MatchedDataFrame, MatchedGRanges, and MatchedGInteractions are listed below:

- `matchedData(x)`: Get matched data from a Matched object

- `covariates(x)`: Get covariates from a Matched object

- `method(x)`: Get matching method used for Matched object

- `withReplacement(x)`: Get replace method

- `indices(x, set)`: Get indices of matched set

For more detail check the help pages for these functions.

### See Also

matchedData, covariates, method, withReplacement, indices

### Examples

    ## Make Matched example
    set.seed(123)
    x <- makeExampleMatchedDataSet(matched = TRUE)
    ## Accessor functions for Matched class
    matchedData(x)
    covariates(x)
    method(x)
    withReplacement(x)
    head(indices(x, set = 'matched'))

[Package nullranges version 1.0.1 Index]