Skip to content

Commit

Permalink
add new man page 'get-values' (#474)
Browse files Browse the repository at this point in the history
  • Loading branch information
thpralas committed Feb 22, 2024
1 parent 1e0b96f commit f08da41
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 20 deletions.
27 changes: 18 additions & 9 deletions R/taxonomy.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,8 @@
#' the lowest taxonomic information possible. If data from different levels,
#' is to be mixed, the taxonomic level is prepended by default.
#'
#' \code{getHierarchyTree} generates a hierarchy tree from the available
#' taxonomic information. Internally it uses
#' \code{\link[TreeSummarizedExperiment:toTree]{toTree}} and
#' \code{\link[TreeSummarizedExperiment:resolveLoop]{resolveLoop}} to sanitize
#' data if needed.
#'
#' \code{addTree} calculates hierarchy tree from the available taxonomic
#' information and add it to rowTree.
#'
#'
#' \code{IdTaxaToDataFrame} extracts taxonomic results from results of
#' \code{\link[DECIPHER:IdTaxa]{IdTaxa}}.
Expand Down Expand Up @@ -383,13 +376,29 @@ setMethod("getTaxonomyLabels", signature = c(x = "SummarizedExperiment"),
ans
}

#' @rdname taxonomy-methods
#' Functions for accessing data
#'
#' These functions find and return data present in a
#' \code{\link[SummarizedExperiment:SummarizedExperiment-class]{SummarizedExperiment}}
#' object.
#'
#' \code{getHierarchyTree} generates a hierarchy tree from the available
#' taxonomic information. Internally it uses
#' \code{\link[TreeSummarizedExperiment:toTree]{toTree}} and
#' \code{\link[TreeSummarizedExperiment:resolveLoop]{resolveLoop}} to sanitize
#' data if needed.
#'
#' @inheritParams taxonomy-methods
#'
#' @name get-values

#' @rdname get-values
setGeneric("getHierarchyTree",
signature = "x",
function(x, ...)
standardGeneric("getHierarchyTree"))

#' @rdname taxonomy-methods
#' @rdname get-values
#' @export
setMethod("getHierarchyTree", signature = c(x = "SummarizedExperiment"),
function(x){
Expand Down
30 changes: 30 additions & 0 deletions man/get-values.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 2 additions & 11 deletions man/taxonomy-methods.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f08da41

Please sign in to comment.