photobiology: is_effective – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

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)

## 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".

Examples

is_effective(summary(sun.spct))

photobiology

Photobiological Calculations

v0.10.10

GPL (>= 2)

Authors

Pedro J. Aphalo [aut, cre] (<https://orcid.org/0000-0003-3385-972X>), Titta K. Kotilainen [ctb] (<https://orcid.org/0000-0002-2822-9734>), Glenn Davis [ctb], Agnese Fazio [ctb]

Initial release

2022-03-24