add examples to documentation

thomaszwagerman · Oct 16, 2024 · a37741c · a37741c
1 parent 08d8310
commit a37741c
Show file tree

Hide file tree

Showing 6 changed files with 103 additions and 17 deletions.
diff --git a/R/catch.R b/R/catch.R
@@ -14,6 +14,15 @@
 #'
 #' @seealso [loupe()]
 #'
+#' @examples
+#' df_caught <- butterfly::catch(
+#'   butterflycount$march,
+#'   butterflycount$february,
+#'   datetime_variable = "time"
+#' )
+#'
+#' df_caught
+#'
 #' @export
 catch <- function(df_current, df_previous, datetime_variable) {
 

diff --git a/R/loupe.R b/R/loupe.R
@@ -24,6 +24,21 @@
 #'
 #' @returns A waldo object containing a message on differences or 'And there are no differences with previous data'.
 #'
+#' @examples
+#' # This example contains no differences with previous data
+#' butterfly::loupe(
+#'  butterflycount$february,
+#'  butterflycount$january,
+#'  datetime_variable = "time"
+#' )
+#'
+#' # This example does contain differences with previous data
+#' butterfly::loupe(
+#'   butterflycount$march,
+#'   butterflycount$february,
+#'   datetime_variable = "time"
+#' )
+#'
 #' @export
 loupe <- function(df_current, df_previous, datetime_variable) {
 

diff --git a/R/release.R b/R/release.R
@@ -14,6 +14,15 @@
 #'
 #' @seealso [loupe()]
 #'
+#' @examples
+#' df_released <- butterfly::release(
+#' butterflycount$march,
+#' butterflycount$february,
+#' datetime_variable = "time"
+#' )
+#'
+#' df_released
+#'
 #' @export
 release <- function(df_current, df_previous, datetime_variable) {
 

diff --git a/man/catch.Rd b/man/catch.Rd
diff --git a/man/loupe.Rd b/man/loupe.Rd
diff --git a/man/release.Rd b/man/release.Rd