Skip to content

Commit

Permalink
docs: fix minor roxygen mistakes
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanbass committed Dec 4, 2024
1 parent bae5821 commit a6e9883
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 14 deletions.
4 changes: 2 additions & 2 deletions R/fit_peaks.R
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,9 @@ find_peaks <- function(y, smooth_type = c("gaussian", "box", "savgol",
#'
#' * Naish, P. J. & Hartwell, S. 1988. Exponentially Modified Gaussian functions - A
#' good model for chromatographic peaks in isocratic HPLC? \emph{Chromatographia},
#' /bold{26}: 285-296. \doi{10.1007/BF02268168}.
#' \bold{26}: 285-296. \doi{10.1007/BF02268168}.
#' @export fit_peaks

#' @md
fit_peaks <- function (x, lambda, pos = NULL, sd.max = 50,
fit = c("egh", "gaussian", "raw"), max.iter = 1000,
estimate_purity = TRUE, noise_threshold = .001, ...){
Expand Down
2 changes: 1 addition & 1 deletion R/get_peaktable.R
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
#' weight given to spectral correlation if \code{sp.rt} is selected.
#' @param deepSplit Logical. Controls sensitivity to cluster splitting. If
#' \code{TRUE}, function will return more smaller clusters. See documentation for
#' \code{\link{cutreeDynamic}} for additional information.
#' \code{\link[dynamicTreeCut]{cutreeDynamic}} for additional information.
#' @param verbose Logical. Whether to print warning when combining peaks into
#' single time window. Defaults to \code{FALSE}.
#' @param out Specify `data.frame` or `matrix` as output. Defaults to
Expand Down
8 changes: 4 additions & 4 deletions R/get_purity.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#' @references
#' Stahl, Mark. “Peak Purity Analysis in HPLC and CE Using Diode-Array Technology.”
#' Agilent Technologies, April 1, 2003, 16.
#' /href{https://www.agilent.com/cs/library/applications/5988-8647EN.pdf}
#' \url{https://www.agilent.com/cs/library/applications/5988-8647EN.pdf}
#' @author Ethan Bass
#' @keywords internal
#' @export
Expand Down Expand Up @@ -98,7 +98,7 @@ find_noise <- function(x, noise_threshold = 0.01, lambdas){
#' @references
#' Stahl, Mark. “Peak Purity Analysis in HPLC and CE Using Diode-Array Technology.”
#' Agilent Technologies, April 1, 2003, 16.
#' /href{https://www.agilent.com/cs/library/applications/5988-8647EN.pdf}
#' \url{https://www.agilent.com/cs/library/applications/5988-8647EN.pdf}
#' @author Ethan Bass
#' @keywords internal
#' @export
Expand Down Expand Up @@ -131,7 +131,7 @@ get_agilent_threshold <- function(x, pos, weight = 1, noise_variance = NULL,
#' @references
#' Stahl, Mark. “Peak Purity Analysis in HPLC and CE Using Diode-Array Technology.”
#' Agilent Technologies, April 1, 2003, 16.
#' /href{https://www.agilent.com/cs/library/applications/5988-8647EN.pdf}
#' \url{https://www.agilent.com/cs/library/applications/5988-8647EN.pdf}
#' @author Ethan Bass
#'@noRd

Expand All @@ -155,7 +155,7 @@ get_spectral_similarity <- function(x, pos){
#' @references
#' Stahl, Mark. “Peak Purity Analysis in HPLC and CE Using Diode-Array Technology.”
#' Agilent Technologies, April 1, 2003, 16.
#' /href{https://www.agilent.com/cs/library/applications/5988-8647EN.pdf}
#' \url{https://www.agilent.com/cs/library/applications/5988-8647EN.pdf}
#' @author Ethan Bass
#' @noRd

Expand Down
9 changes: 5 additions & 4 deletions man/fit_peaks.Rd

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

2 changes: 1 addition & 1 deletion man/get_agilent_threshold.Rd

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

2 changes: 1 addition & 1 deletion man/get_peaktable.Rd

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

2 changes: 1 addition & 1 deletion man/get_purity.Rd

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

0 comments on commit a6e9883

Please sign in to comment.