Improve documentation of returned data.frame

trias-project · Jun 26, 2024 · b3c8d16 · b3c8d16
1 parent 87f93d6
commit b3c8d16
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/R/get_table_pathways.R b/R/get_table_pathways.R
@@ -27,7 +27,8 @@
 #' @param species_names character. Name of the column of \code{df} containing
 #'   information about species names. Default: \code{"canonicalName"}.
 #'
-#' @return a data.frame
+#' @return a data.frame with 4 columns: `pathway_level1`, `pathway_level2`, `n`
+#'   (number of taxa) and `examples`.
 #' @export
 #' @importFrom dplyr %>% .data
 #' @examples

diff --git a/man/get_table_pathways.Rd b/man/get_table_pathways.Rd