Learn R Programming

photobiology (version 0.9.6)

is_effective: Is an R object "effective"

Description

A generic function for quering 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 class 'default':
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 awavebandobject defining a method for calcualtaing effective irradiance.
  • generic_spct: Does asource_spctobject contain effective spectral irradiance values.
  • source_spct: Does asource_spctobject 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

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

Run the code above in your browser using DataLab