Link subtree functions in documentation

DiseaseOntology · Feb 15, 2024 · fad1b50 · fad1b50
1 parent 3b1027f
commit fad1b50
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/R/extract.R b/R/extract.R
@@ -299,6 +299,8 @@ extract_doid_url <- function(doid_edit, include_obsolete = FALSE,
 #' and `parent_label`, with one row for each unique combination for each
 #' subclass below and including `top_node`.
 #'
+#' @seealso [format_subtree()] to arrange data in a tree structure similar to
+#' ontology browsers.
 #' @export
 extract_subtree <- function(x, top_node, reload = FALSE) {
     owl <- access_owl_xml(x)

diff --git a/R/format.R b/R/format.R
@@ -171,6 +171,7 @@ format_obo <- function(x, as = "CURIE", validate_input = TRUE) {
 #'     st_formatted
 #' }
 #'
+#' @seealso [extract_subtree()]
 #' @export
 format_subtree <- function(subtree_df, top_node) {
     rlang::check_installed("tidygraph", reason = "to use `format_subtree()`")

diff --git a/man/extract_subtree.Rd b/man/extract_subtree.Rd
diff --git a/man/format_subtree.Rd b/man/format_subtree.Rd