Skip to contents

Averages infrared spectra within groups

Source: R/ir_average.R
ir_average.Rd

ir_average averages infrared spectra within a user-defined group. NA values are omitted by default.

Usage

ir_average(x, ..., na.rm = TRUE, .groups = "drop")

Arguments

x

An object of class ir.

...

Variables in x to use as groups.

na.rm

A logical value indicating if NA values should be dropped (TRUE) or not (FALSE).

.groups

[Experimental] Grouping structure of the result.

  • "drop_last": dropping the last level of grouping. This was the only supported option before version 1.0.0.

  • "drop": All levels of grouping are dropped.

  • "keep": Same grouping structure as .data.

  • "rowwise": Each row is its own group.

When .groups is not specified, it is chosen based on the number of rows of the results:

  • If all the results have 1 row, you get "drop_last".

  • If the number of rows varies, you get "keep" (note that returning a variable number of rows was deprecated in favor of reframe(), which also unconditionally drops all levels of grouping).

In addition, a message informs you of that choice, unless the result is ungrouped, the option "dplyr.summarise.inform" is set to FALSE, or when summarise() is called from a function in a package.

Value

An object of class ir where spectra have been averaged within groups defined by ....

Examples

# average the sample data spectra across sample types
x <-
  ir_sample_data |>
  ir_average(sample_type)