familyNames {rexposome} | R Documentation

## Getter to obtain the exposures's names of an ExposomeSet.

### Description

This method returns the name of the families in an ExposomeSet, but it can return a vector, labeled with the exposures in the ExposomeSet, containing the family belonging to each exposure.

### Usage

    familyNames(object, by.exposure = FALSE)

### Arguments

`object` | `ExposomeSet` that will be queried for the exposures's family-names.
`by.exposure` | (default `FALSE`) If `TRUE` a vector labeled with each exposure name will be returned with the family of each exposures. If `FALSE` a vector with the (unique) name of the families of exposures will be returned.

### Value

The families of the exposures into the ExposomeSet, or the family of each exposure into the ExposomeSet.

### See Also

exposureNames to get the name of the exposures, phenotypeNames to get the phenotypes

### Examples

    data("exposome")
    # Get families
    familyNames(expo)
    # Get the family of each exposure
    familyNames(expo, by.exposure = TRUE)

[Package rexposome version 1.14.1 Index]