Learn R Programming

photobiology (version 0.11.3)

is_effective: 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)

# S3 method for default is_effective(x)

# S3 method for waveband is_effective(x)

# S3 method for generic_spct is_effective(x)

# S3 method for source_spct is_effective(x)

# S3 method for summary_generic_spct is_effective(x)

# S3 method for summary_source_spct is_effective(x)

Value

A logical.

Arguments

x

an R object

Methods (by class)

  • is_effective(default): Default method.

  • is_effective(waveband): Is a waveband object defining a method for calculating effective irradiance.

  • is_effective(generic_spct): Does a source_spct object contain effective spectral irradiance values.

  • is_effective(source_spct): Does a source_spct object contain effective spectral irradiance values.

  • is_effective(summary_generic_spct): Method for "summary_generic_spct".

  • is_effective(summary_source_spct): Method for "summary_source_spct".

See Also

Other waveband attributes: labels(), normalization()

Examples

Run this code
is_effective(summary(sun.spct))

Run the code above in your browser using DataLab