update function documentation

traitecoevo · Jan 24, 2024 · b53d933 · b53d933
1 parent 12cbe01
commit b53d933
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/NAMESPACE b/NAMESPACE
@@ -5,6 +5,7 @@ export(build_add_version)
 export(build_combine)
 export(build_setup_pipeline)
 export(check_pivot_duplicates)
+export(database_create_combined_table)
 export(dataset_build)
 export(dataset_configure)
 export(dataset_find_taxon)

diff --git a/R/output_combined_table.R b/R/output_combined_table.R
@@ -8,10 +8,11 @@
 #'
 #' @param database A traits.build database
 #'
-#' @return
+#' @return A table combining information in 7 traits.build relational tables: traits, locations, contexts, methods, taxa, taxonomic_updates, and contributors
 #' @export
 #'
 #' @examples
+#' combined_database_table <- database_create_combined_table(database)
 database_create_combined_table <- function(database) {
 
   location_latlon <-

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