This function allows easy calculation of any quantities derived from other variables. The new quantities can be assigned to a specific data_type and values, errors as well as the resulting variable names are calculated/constructed based on custom functions that can be provided via the function parameters. calculate_sums, calculate_ratios and calculate_abundances are all based on this and provide an easy way for common standard calculations.
calculate( data, data_type, ..., value_fun, error_fun = function(...) return(NA), name_fun = default_name, filter_new = NULL, quiet = FALSE )
| data | a data frame with lans2r data, can be grouped to do calculations within individual groups |
|---|---|
| data_type | what to call the new data type |
| ... | the parameters to send to the value, error and naming function for each derived value. These are always expressions that can include references to variable columns, arithmetic and constants, e.g. c(`12C`, `13C`) or c("test", 100*(`12C`+`13C`)). The number of parameters needs to match those expected by the value, error and name functions. Error values of different columns (say for classical error propagation) can be addressed using the suffix "sigma", e.g. c(`12C`, `12C sigma`) would pass both the value and error of this variable to the functions. |
| value_fun | a custom function used to calculate the derived value - needs to match the sets of parameters provided through ... |
| error_fun | a custom function used to calculate the error (sigma) for the derived value - needs to match the sets of parameters provided through ... |
| name_fun | a custom function used to construct the variable name for the derived quantity - needs to match the sets of parameters provided through ... |
| filter_new | an expression to apply as a filter on the new data rows (e.g. plane == "all") |
| quiet | whether the function should output information messages or be quiet (default is to output) |
the original data frame with the newly calculated information appended (data_type == "ion_sum")
Other calculations:
calculate_abundances(),
calculate_ratios(),
calculate_sums()