diff --git a/R/plots-standard_curve.R b/R/plots-standard_curve.R index f38996a..9684432 100644 --- a/R/plots-standard_curve.R +++ b/R/plots-standard_curve.R @@ -291,6 +291,11 @@ plot_standard_curve_thumbnail <- function(plate, analyte_name, data_type = "Medi #' levey-jennings report in mind, but it can be run by itself. #' #' @param list_of_plates list of Plate objects +#' @param analyte_name Name of the analyte of which standard curves we want to plot. +#' @param data_type Data type of the value we want to plot - the same datatype as in the plate file. By default equals to `Median` +#' @param decreasing_dilution_order If `TRUE` the dilution values are plotted in decreasing order, `TRUE` by default +#' @param log_scale Which elements on the plot should be displayed in log scale. By default `"all"`. If `NULL` or `c()` no log scale is used, if `"all"` or `c("dilutions", "MFI")` all elements are displayed in log scale. +#' @param verbose If `TRUE` prints messages, `TRUE` by default #' #' @return ggplot object with the plot #' diff --git a/man/Model.Rd b/man/Model.Rd index a8218c0..c9a93a1 100644 --- a/man/Model.Rd +++ b/man/Model.Rd @@ -154,7 +154,7 @@ Use values before any transformations (e.g., before the \code{log10} transformat \subsection{Method \code{predict()}}{ Predict RAU values from the MFI values \subsection{Usage}{ -\if{html}{\out{
}}\preformatted{Model$predict(mfi, over_max_extrapolation = 0, eps = 1e-06)}\if{html}{\out{
}} +\if{html}{\out{
}}\preformatted{Model$predict(mfi, over_max_extrapolation = 0, eps = 0.000001)}\if{html}{\out{
}} } \subsection{Arguments}{ diff --git a/man/plot_standard_curve_stacked.Rd b/man/plot_standard_curve_stacked.Rd index 15693fc..b42ee84 100644 --- a/man/plot_standard_curve_stacked.Rd +++ b/man/plot_standard_curve_stacked.Rd @@ -4,15 +4,33 @@ \alias{plot_standard_curve_stacked} \title{Standard curve stacked plot for levey-jennings report} \usage{ -plot_standard_curve_stacked(plate) +plot_standard_curve_stacked( + list_of_plates, + analyte_name, + data_type = "Median", + decreasing_dilution_order = TRUE, + log_scale = c("all"), + verbose = TRUE +) } \arguments{ -\item{plate}{Plate object} +\item{list_of_plates}{list of Plate objects} + +\item{analyte_name}{Name of the analyte of which standard curves we want to plot.} + +\item{data_type}{Data type of the value we want to plot - the same datatype as in the plate file. By default equals to \code{Median}} + +\item{decreasing_dilution_order}{If \code{TRUE} the dilution values are plotted in decreasing order, \code{TRUE} by default} + +\item{log_scale}{Which elements on the plot should be displayed in log scale. By default \code{"all"}. If \code{NULL} or \code{c()} no log scale is used, if \code{"all"} or \code{c("dilutions", "MFI")} all elements are displayed in log scale.} + +\item{verbose}{If \code{TRUE} prints messages, \code{TRUE} by default} } \value{ ggplot object with the plot } \description{ -Function generates a plot of stacked on top of each other standard curves for a given plate. -The plot is created with the levey-jennings report in mind. But it can be run by itself. +Function generates a plot of stacked on top of each other standard curves +for a given analyte form a list of plates. The plot is created with the +levey-jennings report in mind, but it can be run by itself. }