Add '@family' tags for each of the package functions

LieberInstitute · Oct 16, 2023 · d2d46c5 · d2d46c5
1 parent 06569ec
commit d2d46c5
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 0 deletions.
diff --git a/R/array_submit.R b/R/array_submit.R
@@ -26,6 +26,8 @@
 #' @author Leonardo Collado-Torres
 #' @author Nicholas J. Eagles
 #'
+#' @family shell-script creation and submission functions
+#' 
 #' @examples
 #'
 #' ## Choose a script name

diff --git a/R/job_info.R b/R/job_info.R
@@ -13,6 +13,8 @@
 #' @export
 #' @author Nicholas J. Eagles
 #' @import dplyr stringr utils
+#' 
+#' @family monitoring and informational functions
 #'
 #' @examples
 #'

diff --git a/R/job_loop.R b/R/job_loop.R
@@ -15,6 +15,8 @@
 #' @author Nicholas J. Eagles
 #' @author Leonardo Collado-Torres
 #' @import purrr
+#' 
+#' @family shell-script creation and submission functions
 #'
 #' @examples
 #'

diff --git a/R/job_report.R b/R/job_report.R
@@ -9,6 +9,8 @@
 #' @export
 #' @author Nicholas J. Eagles
 #' @import dplyr stringr utils
+#' 
+#' @family monitoring and informational functions
 #'
 #' @examples
 #'

diff --git a/R/job_single.R b/R/job_single.R
@@ -39,6 +39,8 @@
 #' @author Leonardo Collado-Torres
 #' @author Nicholas J. Eagles
 #' @import glue utils
+#' 
+#' @family shell-script creation and submission functions
 #'
 #' @examples
 #'

diff --git a/R/partition_info.R b/R/partition_info.R
@@ -14,6 +14,8 @@
 #' @export
 #' @author Nicholas J. Eagles
 #' @import dplyr utils
+#' 
+#' @family monitoring and informational functions
 #'
 #' @examples
 #'

diff --git a/man/job_info.Rd b/man/job_info.Rd
diff --git a/man/job_report.Rd b/man/job_report.Rd
diff --git a/man/partition_info.Rd b/man/partition_info.Rd