-
Notifications
You must be signed in to change notification settings - Fork 1
/
calculate_sums.Rd
37 lines (34 loc) · 1.46 KB
/
calculate_sums.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/calculations.R
\name{calculate_sums}
\alias{calculate_sums}
\title{Calculate ion sums}
\usage{
calculate_sums(data, ..., name_fun = default_name, quiet = FALSE)
}
\arguments{
\item{data}{a data frame with raw ion counts retrieved from \code{\link{load_LANS_summary}}}
\item{...}{the ion sums to calculate, each entry is for one sum of as many ions as desired,
e.g. c(\verb{13C}, \verb{12C}), c(\verb{15N12C}, \verb{14C12C}), ...}
\item{name_fun}{the naming function, receives ... from the top level, default concatenates column names with '+'}
\item{quiet}{whether the function should output information messages or be quiet (default is to output)}
}
\value{
the original data frame with the sums information appended (data_type == "ion_sum")
}
\description{
This function calculates the ion sums and resulting counting
statistics error from multiple raw ion counts. It can be applied to data from both
LANS_summary and LANS_maps loading but can be slow if LANS_maps is combined
from many analyses. Careful about its error propagation, it assumes it is calculating
sums of ions and uses the ion counts themselves for error calculation. This is not
suitable for calculating other types of sums where other types of error propagation
may be more appropriate.
}
\seealso{
Other calculations:
\code{\link{calculate_abundances}()},
\code{\link{calculate_ratios}()},
\code{\link{calculate}()}
}
\concept{calculations}