Skip to content

Commit

Permalink
doc string edits
Browse files Browse the repository at this point in the history
  • Loading branch information
NicWir committed Jan 25, 2024
1 parent 64326f5 commit 36fca27
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion R/fluorescence_plots.R
Original file line number Diff line number Diff line change
Expand Up @@ -3196,7 +3196,7 @@ plot.dual <- function(x,

#' Generic plot function for \code{drFitFL} objects.
#'
#' code{drFitfl} calls \code{\link{plot.drFitFLModel}} for each group used in a dose-response analysis with \code{dr.method = "model"}
#' \code{drFitfl} calls \code{\link{plot.drFitFLModel}} for each group used in a dose-response analysis with \code{dr.method = "model"}
#'
#' @param x object of class \code{drFit}, created with \code{\link{growth.drFit}}.
#' @param pch (Numeric) Shape of the raw data symbols.
Expand Down
8 changes: 4 additions & 4 deletions R/growth_plots.R
Original file line number Diff line number Diff line change
Expand Up @@ -1039,7 +1039,7 @@ plot.drBootSpline <- function (x,

#' Generic plot function for \code{drFit} objects.
#'
#' code{plot.drFit} calls code{plot.drFitSpline} for each group used in a dose-response analysis
#' \code{plot.drFit} calls \code{plot.drFitSpline} for each group used in a dose-response analysis
#'
#' @param x object of class \code{drFit}, created with \code{\link{growth.drFit}}.
#' @param combine (Logical) Combine the dose-response analysis results of all conditions into a single plot (\code{TRUE}) or not (\code{FALSE}).
Expand Down Expand Up @@ -1349,7 +1349,7 @@ plot.drFit <- function(x, combine = TRUE, names = NULL, exclude.nm = NULL, pch =

#' Generic plot function for \code{drFitSpline} objects.
#'
#' code{plot.drFitSpline} generates the spline fit plot for response-parameter vs. concentration data
#' \code{plot.drFitSpline} generates the spline fit plot for response-parameter vs. concentration data
#'
#' @param x object of class \code{drFitSpline}, created with \code{\link{growth.drFitSpline}}.
#' @param add (Logical) Shall the fitted spline be added to an existing plot? \code{TRUE} is used internally by \code{\link{plot.drBootSpline}}.
Expand Down Expand Up @@ -2243,7 +2243,7 @@ plot.gcBootSpline <- function(x, pch = 1, colData=1, deriv = TRUE,

#' Generic plot function for \code{gcFitSpline} objects.
#'
#' code{plot.gcFitSpline} generates the spline fit plot for a single sample.
#' \code{plot.gcFitSpline} generates the spline fit plot for a single sample.
#'
#' @param x object of class \code{gcFitSpline}, created with \code{\link{growth.gcFitSpline}}.
#' @param add (Logical) Shall the fitted spline be added to an existing plot? \code{TRUE} is used internally by \code{\link{plot.gcBootSpline}}.
Expand Down Expand Up @@ -4411,7 +4411,7 @@ plot.dr_parameter <- function(x, param = c('EC50', 'EC50.Estimate', 'y.max', 'y.
#'
#' \code{plot.grid} takes a \code{grofit} or \code{flFitRes} object and returns a facet grid of individual growth and fluorescence plots
#'
#' @param x A \code{grofit} or \code{flFitRes} object created with \code{\link{growth.workflow}} or code{\link{fl.workflow}} containing spline fits.
#' @param x A \code{grofit} or \code{flFitRes} object created with \code{\link{growth.workflow}} or \code{\link{fl.workflow}} containing spline fits.
#' @param data.type (Character) Plot either raw data (\code{data.type = "raw"}) or the spline fit results
#' @param param (Character) The parameter used to compare different sample groups. Any name of a column containing numeric values in \code{gcTable} (which is stored within \code{grofit} or \code{gcFit} objects) can be used as input. Useful options are:
#' 'mu.linfit', 'lambda.linfit', 'dY.linfit', 'A.linfit',
Expand Down
4 changes: 2 additions & 2 deletions R/linear_fits.R
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
#' \item{gcID}{(Character) Identifies the tested sample.}
#' \item{FUN}{Linear _function_ used for plotting the tangent at mumax.}
#' \item{fit}{\code{lm} object; result of the final call of \code{\link{lm}} to perform the linear regression.}
#' \item{par}{List of determined growth parameters.}
#' \item{par}{List of determined growth parameters:}
#' \itemize{
#' \item \code{y0}: {Minimum growth value considered for the heuristic linear method.}
#' \item \code{dY}: {Difference in maximum growth and minimum growth.}
Expand Down Expand Up @@ -921,7 +921,7 @@ growth.gcFitLinear <- function(time, data, gcID = "undefined", quota = 0.95,
#' \item{ID}{(Character) Identifies the tested sample.}
#' \item{FUN}{Linear _function_ used for plotting the tangent at mumax.}
#' \item{fit}{\code{lm} object; result of the final call of \code{\link{lm}} to perform the linear regression.}
#' \item{par}{List of determined fluorescence parameters.}
#' \item{par}{List of determined fluorescence parameters:}
#' \itemize{
#' \item \code{y0}: {Minimum fluorescence value considered for the heuristic linear method.}
#' \item \code{dY}: {Difference in maximum fluorescence and minimum fluorescence}
Expand Down
8 changes: 4 additions & 4 deletions R/report_functions.R
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@ growth.report <- function(
}
if(export == T){
wd.plots <- paste0(wd,"/Plots")
dir.create(paste0(tempdir(), "/Plots"), showWarnings = F)
dir.create(wd.plots, showWarnings = F)
dir.create(paste0(tempdir(), "/Plots"), showWarnings = T)
dir.create(wd.plots, showWarnings = T)
}

rmarkdown::render(
Expand Down Expand Up @@ -453,8 +453,8 @@ fl.report <- function(

if(export == T){
wd.plots <- paste0(wd,"/Plots")
dir.create(paste0(tempdir(), "/Plots"), showWarnings = F)
dir.create(wd.plots, showWarnings = F)
dir.create(paste0(tempdir(), "/Plots"), showWarnings = T)
dir.create(wd.plots, showWarnings = T)
}

rmarkdown::render(
Expand Down
2 changes: 1 addition & 1 deletion man/growth.gcFitLinear.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 36fca27

Please sign in to comment.