RNeXML (version 2.4.0)

nexml_write: Write nexml files

Description

Write nexml files

Usage

nexml_write(x = nexml(), file = NULL, trees = NULL,
  characters = NULL, meta = NULL, ...)

Arguments

x

a nexml object, or any phylogeny object (e.g. phylo, phylo4) that can be coerced into one. Can also be omitted, in which case a new nexml object will be constructed with the additional parameters specified.

file

the name of the file to write out

trees

phylogenetic trees to add to the nexml file (if not already given in x) see add_trees for details.

characters

additional characters

meta

A meta element or list of meta elements, see add_meta

...

additional arguments to add__basic_meta, such as the title. See add_basic_meta.

Value

Writes out a nexml file

See Also

add_trees add_characters add_meta nexml_read

Examples

Run this code
# NOT RUN {
 ## Write an ape tree to nexml, analgous to write.nexus:
 library(ape); data(bird.orders)
 ex <- tempfile(fileext=".xml")
 write.nexml(bird.orders, file=ex)

# }
# NOT RUN {
 # takes > 5s
 ## Assemble a nexml section by section and then write to file:
 library(geiger)
 data(geospiza)
 nexml <- add_trees(geospiza$phy) # creates new nexml
 nexml <- add_characters(geospiza$dat, nexml = nexml) # pass the nexml obj to append character data
 nexml <- add_basic_meta(title="my title", creator = "Carl Boettiger", nexml = nexml)
 nexml <- add_meta(meta("prism:modificationDate", format(Sys.Date())), nexml = nexml)

 write.nexml(nexml, file=ex)

 ## As above, but in one call (except for add_meta() call).  
 write.nexml(trees = geospiza$phy, 
             characters = geospiza$dat, 
             title = "My title", 
             creator = "Carl Boettiger",
             file = ex)
 
 ## Mix and match: identical to the section by section: 
 nexml <- add_meta(meta("prism:modificationDate", format(Sys.Date())))
 write.nexml(x = nexml,
             trees = geospiza$phy, 
             characters = geospiza$dat, 
             title = "My title", 
             creator = "Carl Boettiger",
             file = ex)

# }

Run the code above in your browser using DataCamp Workspace