WriteOut: Write spgeoOUT Objects to the Working Directory

View source: R/WriteOut.R

WriteOutR Documentation

Write spgeoOUT Objects to the Working Directory

Description

Writes objects of the class ‘spgeoOUT’ (as generated by SpGeoCod) to the working directory. Output statistics as .txt files, maps and plots as .pdf and a nexus file for use in phylogenetic analyses.

Usage

WriteOut(x, type = "all")

Arguments

x

an object of the class spgeoOUT

type

a character string. Defines which results should be written to disk. One of "all", "BioGeoBEARS", "BayArea", "graphs", "maps", "nexus", "stats". Default is to “all”.

Details

There are different options for the writetype argument: “all” = all summary tables, plots and maps; “BioGeoBEARS” = a text file in the geography input format of BioGeoBEARS; “BayArea” = two text files in the input format of BayArea; “graphs” = summary graphs as pdf files; “maps” = summary maps as .pdf file; “nexus” = the species to area classification as nexus file; “stats” = the summary tables as .txt files.

Value

a set of files in the working directory

Note

See https://github.com/azizka/speciesgeocodeR/wiki for more details and tutorials.

See Also

SpGeoCod

Examples

## Not run: 
data(lemurs)
data(mdg_biomes)

outp <- SpGeoCodH(lemurs, mdg_biomes, areanames = 'name')
WriteOut(outp)
WriteOut(outp, writetype = "graphs")
WriteOut(outp, writetype = "statistics")
WriteOut(outp, writetype = "nexus")

## End(Not run)

azizka/speciesgeocodeR documentation built on Sept. 5, 2023, 3:45 a.m.