/
iso_get_calibration_coefficients.Rd
60 lines (51 loc) · 3.15 KB
/
iso_get_calibration_coefficients.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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/calibration.R
\name{iso_get_calibration_coefficients}
\alias{iso_get_calibration_coefficients}
\alias{iso_unnest_calibration_coefs}
\title{Get calibration coefficients}
\usage{
iso_get_calibration_coefficients(
dt,
calibration = last_calibration(dt),
select = everything(),
keep_calibration_parameters = keep_other_list_data,
keep_calibration_regressions = FALSE,
keep_other_calibrations = FALSE,
quiet = default(quiet),
keep_remaining_nested_data = FALSE,
keep_other_list_data = FALSE
)
iso_unnest_calibration_coefs(...)
}
\arguments{
\item{dt}{nested data frame with column \code{all_data} (see \link{iso_prepare_for_calibration}) and any number of calibrations (see \link{iso_generate_calibration})}
\item{select}{which columns to unnest - use \code{c(...)} to select multiple, supports all \link[dplyr]{select} syntax including renaming columns. Includes all columns by default (i.e. unnests all information).}
\item{keep_calibration_parameters}{whether to keep the calibration parameter columns (coefficients, summary, range) in the resulting data frame. By default, calibration parameters are kept to facilitate downstream operations that may need these calibration information (such as \link{iso_mark_calibration_range}).}
\item{keep_calibration_regressions}{whether to keep the actual calibration regression objects in the resulting data frame. By default, regression objects are NOT kept because they lead to large data objects and do not usually have additional use after \link{iso_apply_calibration} has been called. There is rarely a reason to change this parameter to \code{TRUE}.}
\item{keep_other_calibrations}{whether columns that belong to other calibrations (besides the one specified by \code{calibration}) should be kept in the data table. By default, they are removed for clarity.}
\item{quiet}{whether to display (quiet=FALSE) or silence (quiet = TRUE) information messages.}
\item{keep_remaining_nested_data}{DEPRECATED - this parameter was removed for clarity and does no longer have any effect}
\item{keep_other_list_data}{DEPRECATED - renamed to \code{keep_calibrations}}
\item{...}{additional parameters to forward to the \code{func} function}
}
\description{
Retrieve calibration coefficients for a calibration generated by \link{iso_generate_calibration}.
}
\details{
\code{iso_unnest_calibration_coefs} is deprecated in favor of the equivalent \code{iso_get_calibration_coefficients} to standardize function call names. Please start using \code{iso_get_calibration_coefficients} as \code{iso_unnest_calibration_coefs} will be deprecated in a future version of isoprocessor.
}
\seealso{
Other calibration functions:
\code{\link{iso_add_standards}()},
\code{\link{iso_apply_calibration}()},
\code{\link{iso_evaluate_calibration_range}()},
\code{\link{iso_generate_calibration}()},
\code{\link{iso_get_calibration_data}()},
\code{\link{iso_get_calibration_range}()},
\code{\link{iso_get_calibration_summary}()},
\code{\link{iso_get_problematic_calibrations}()},
\code{\link{iso_prepare_for_calibration}()},
\code{\link{iso_remove_problematic_calibrations}()}
}
\concept{calibration functions}