getResults: Get Results from Object

Description Usage Arguments Value

View source: R/8-get.R

Description

This function provides a unified wrapper to retrieve results from a propr or propd object.

Usage

1
getResults(object, cutoff = NA, include = NA, or = TRUE)

Arguments

object

A propr or propd object.

cutoff

This argument indicates the value at which to cutoff the results. For "rho" and "cor", the function returns pairs with a value greater than the cutoff. For "theta", "phi", and "phs", the function returns pairs with a value less than the cutoff. Leave the argument as NA to return all results.

include

This argument indicates which features by name should belong to a pair for that pair to get included in the results. Subset performed by Partner %in% subset | Pair %in% subset.

or

A boolean. If FALSE, include subsets by Partner %in% subset & Pair %in% subset.

Value

A data.frame of results.


propr documentation built on Dec. 16, 2019, 9:30 a.m.