Documentation updates for CRAN submission (#77)

COMPASS-DOE · Oct 7, 2024 · 08737c6 · 08737c6
1 parent 50afb90
commit 08737c6
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 2 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -30,3 +30,4 @@ Suggests:
 Config/testthat/edition: 3
 RoxygenNote: 7.3.1
 VignetteBuilder: knitr
+BugReports: https://github.com/COMPASS-DOE/fluxfinder/issues
diff --git a/R/qaqc.R b/R/qaqc.R
@@ -10,7 +10,7 @@
 #' @param output_dir Name of the output directory; default is current working directory
 #' @param open_output Automatically open the output HTML file?
 #' @importFrom utils browseURL
-#' @return The path of the output file
+#' @return The path of the output file.
 #' @export
 #'
 #' @examples

diff --git a/R/read_data_functions.R b/R/read_data_functions.R
@@ -8,6 +8,7 @@
 #' and \code{\link{ffi_read_LI7820}}, and not normally called by users.
 #' @importFrom utils read.table
 #' @importFrom lubridate ymd_hms
+#' @keywords internal
 #' @return A \code{\link{data.frame}} with the parsed data.
 ffi_read_LI78x0 <- function(file, model) {
 

diff --git a/man/ffi_qaqc.Rd b/man/ffi_qaqc.Rd
diff --git a/man/ffi_read_LI78x0.Rd b/man/ffi_read_LI78x0.Rd