R: Expanse

spread {photobiology} | R Documentation

## Expanse

### Description

A function that returns the expanse (max(x) - min(x)) for R objects.

### Usage

    spread(x, ...)

    wl_expanse(x, ...)

    expanse(x, ...)

    ## Default S3 method:
    expanse(x, ...)

    ## S3 method for class 'numeric'
    expanse(x, ...)

    ## S3 method for class 'waveband'
    expanse(x, ...)

    ## S3 method for class 'generic_spct'
    expanse(x, ...)

    ## S3 method for class 'generic_mspct'
    expanse(x, ..., idx = !is.null(names(x)))

### Arguments

`x` | an R object
`...` | not used in current version
`idx` | logical whether to add a column with the names of the elements of spct

### Value

A numeric value equal to max(x) - min(x). In the case of spectral objects wavelength difference in nm. For any other R object, according to available definitions of `min` and `max`.

### Methods (by class)

- `default`: Default method for generic function

- `numeric`: Method for "numeric"

- `waveband`: Method for "waveband"

- `generic_spct`: Method for "generic_spct"

- `generic_mspct`: Method for "generic_mspct" objects.

### Examples

    expanse(10:20)
    expanse(sun.spct)
    wl_expanse(sun.spct)

    expanse(sun.spct)

[Package photobiology version 0.9.21 Index]