Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding read.treeqza to parse tree qza file from output of qiime2 #46

Merged
merged 4 commits into from Mar 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion DESCRIPTION
Expand Up @@ -34,7 +34,8 @@ Suggests:
testthat,
tidyr,
vroom,
xml2
xml2,
yaml
VignetteBuilder: knitr
ByteCompile: true
License: Artistic-2.0
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Expand Up @@ -105,6 +105,7 @@ export(read.phyloxml)
export(read.r8s)
export(read.raxml)
export(read.tree)
export(read.treeqza)
export(rename_taxa)
export(rescale_tree)
export(root)
Expand Down
34 changes: 34 additions & 0 deletions R/treeqza.R
@@ -0,0 +1,34 @@
#' @title read.treeqza
#' @param treeqza the qiime2 output file contained tree file.
#' @param node.label parse node label as 'label' or 'support' value.
#' @param ... additional parameter, passed to 'read.tree'.
#' @return phylo tree object or treedata object when node.label was parsed 'support'.
#' @export
#' @examples
#' qzafile1 <- system.file("extdata/qiime2treeqza", "fasttree-tree.qza", package="treeio")
#' qzafile2 <- system.file("extdata/qiime2treeqza", "iqt-tree.qza", package="treeio")
#' qzafile3 <- system.file("extdata/qiime2treeqza", "raxml-cat-tree.qza", package="treeio")
#' tr1 <- read.treeqza(qzafile1)
#' tr1
#' tr2 <- read.treeqza(qzafile2)
#' tr2
#' tr3 <- read.treeqza(qzafile3)
#' tr3
#' # parse node label as 'support' value.
#' qzafile4 <- system.file("extdata/qiime2treeqza", "raxml-cat-bootstrap-tree.qza", package="treeio")
#' tr4 <- read.treeqza(qzafile4, node.label="support")
#' tr4
read.treeqza <- function(treeqza, node.label = "label", ...){
tmpdir <- tempdir()
unzipfiles <- utils::unzip(treeqza, exdir=tmpdir)
metadafile <- unzipfiles[grep("metadata.yaml", unzipfiles)[1]]
metaflag <- yaml::read_yaml(metadafile)
formatflag <- metaflag$format
if (formatflag!="NewickDirectoryFormat"){
stop("Please check whether treeqza file contained tree file!")
}else{
datafile <- unzipfiles[grep("data/tree.nwk", unzipfiles)]
x <- read.newick(datafile, node.label=node.label, ...)
return (x)
}
}
Binary file added inst/extdata/qiime2treeqza/fasttree-tree.qza
Binary file not shown.
Binary file added inst/extdata/qiime2treeqza/iqt-tree.qza
Binary file not shown.
Binary file not shown.
Binary file added inst/extdata/qiime2treeqza/raxml-cat-tree.qza
Binary file not shown.
36 changes: 36 additions & 0 deletions man/read.treeqza.Rd

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

10 changes: 10 additions & 0 deletions tests/testthat/test-treeqza.R
@@ -0,0 +1,10 @@
context("tree qza file (output of qiime2 phylogenetic inference) input")

library(treeio)
qzafile <- system.file("extdata/qiime2treeqza", "fasttree-tree.qza", package="treeio")

tr <- read.treeqza(qzafile)

test_that("read.treeqza should work for tree qza file",{
expect_true(is(tr, "phylo"))
})