doc: add examples

KaiAragaki · May 6, 2024 · baa0d15 · baa0d15
1 parent 84c47fb
commit baa0d15
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 2 deletions.
diff --git a/R/qp.R b/R/qp.R
@@ -24,6 +24,12 @@
 #'   `spectramax`
 #'
 #' @return a `tibble`
+#'
+#' @examples
+#'
+#' data <- system.file("extdata", "absorbances.txt", package = "qp")
+#' qp(data, replicate_orientation = "h")
+#'
 #' @export
 #' @importFrom rlang .data
 qp <- function(x,

diff --git a/R/qp_tidy.R b/R/qp_tidy.R
@@ -16,6 +16,12 @@
 #'   will be minimal and mostly focused on checking for validity.
 #'
 #' @return a `data.frame`
+#'
+#' @examples
+#'
+#' data <- system.file("extdata", "absorbances.txt", package = "qp")
+#' qp_tidy(data)
+#'
 #' @export
 #' @importFrom rlang .data
 qp_tidy <- function(x, ...) {

diff --git a/man/qp.Rd b/man/qp.Rd
diff --git a/man/qp_calc_conc.Rd b/man/qp_calc_conc.Rd
diff --git a/man/qp_fit.Rd b/man/qp_fit.Rd
diff --git a/man/qp_tidy.Rd b/man/qp_tidy.Rd