Import HUMAnN results to TreeSummarizedExperiment

Source: R/importHumann.R

Import HUMAnN results to TreeSummarizedExperiment

Arguments

file

Character scalar. Defines the file path of the HUMAnN file. The file must be in merged HUMAnN format.

col.data

a DataFrame-like object that includes sample names in rownames, or a single character value defining the file path of the sample metadata file. The file must be in tsv format (Default: NULL).

colData

Deprecated. Use col.data instead.

...

additional arguments:

  • assay.type: Character scalar. Specifies the name of the assy used in calculation. (Default: "counts")

  • prefix.rm: Logical scalar. Should taxonomic prefixes be removed? (Default: FALSE)

  • remove.suffix: Logical scalar. Should suffixes of sample names be removed? HUMAnN pipeline adds suffixes to sample names. Suffixes are formed from file names. By selecting remove.suffix = TRUE, you can remove pattern from end of sample names that is shared by all. (Default: FALSE)

Value

A TreeSummarizedExperiment object

Details

Import HUMAnN (currently version 3.0 supported) results of functional predictions based on metagenome composition (e.g. pathways or gene families). The input must be in merged HUMAnN format. (See the HUMAnN documentation and humann_join_tables method.)

The function parses gene/pathway information along with taxonomy information from the input file. This information is stored to rowData. Abundances are stored to assays.

Usually the workflow includes also taxonomy data from Metaphlan. See importMetaPhlAn to load the data to TreeSE.

References

Beghini F, McIver LJ, Blanco-Míguez A, Dubois L, Asnicar F, Maharjan S, Mailyan A, Manghi P, Scholz M, Thomas AM, Valles-Colomer M, Weingart G, Zhang Y, Zolfo M, Huttenhower C, Franzosa EA, & Segata N (2021) Integrating taxonomic, functional, and strain-level profiling of diverse microbial communities with bioBakery 3. eLife. 10:e65088.

Examples

# File path
file_path <- system.file("extdata", "humann_output.tsv", package = "mia")
# Import data
tse <- importHUMAnN(file_path)
tse
#> class: TreeSummarizedExperiment 
#> dim: 12 3 
#> metadata(0):
#> assays(1): counts
#> rownames(12): UNMAPPED UniRef50_unknown ... UniRef50_O83668:
#>   Fructose-bisphosphate
#>   aldolase|g__Bacteroides.s__Bacteroides_thetaiotaomicron
#>   UniRef50_O83668: Fructose-bisphosphate
#>   aldolase|g__Bacteroides.s__Bacteroides_stercoris
#> rowData names(4): Gene_Family_long Gene_Family genus species
#> colnames(3): sample1 sample2 sample3
#> colData names(0):
#> reducedDimNames(0):
#> mainExpName: NULL
#> altExpNames(0):
#> rowLinks: NULL
#> rowTree: NULL
#> colLinks: NULL
#> colTree: NULL