R: Is an R object "effective"

is_effective {photobiology} | R Documentation

## Is an R object "effective"

### Description

A generic function for querying if a biological spectral weighting function (BSWF) has been applied to an object or is included in its definition.

### Usage

    is_effective(x)

    ## Default S3 method:
    is_effective(x)

    ## S3 method for class 'waveband'
    is_effective(x)

    ## S3 method for class 'generic_spct'
    is_effective(x)

    ## S3 method for class 'source_spct'
    is_effective(x)

    ## S3 method for class 'summary_generic_spct'
    is_effective(x)

    ## S3 method for class 'summary_source_spct'
    is_effective(x)

### Arguments

`x` | an R object

### Value

A `logical`.

### Methods (by class)

- `default`: Default method.

- `waveband`: Is a `waveband` object defining a method for calculating effective irradiance.

- `generic_spct`: Does a `source_spct` object contain effective spectral irradiance values.

- `source_spct`: Does a `source_spct` object contain effective spectral irradiance values.

- `summary_generic_spct`: Method for "summary_generic_spct".

- `summary_source_spct`: Method for "summary_source_spct".

### See Also

Other waveband attributes: `labels`, `normalization`

### Examples

    is_effective(summary(sun.spct))

[Package photobiology version 0.9.21 Index]