phylter (version 0.9.12)

write.phylter: Write summary of phyter analysis to file(s)

Description

Write the summary of the phylter analysis in a txt file or as a pdf report.

Usage

write.phylter(
  x,
  file = "",
  include.discarded = TRUE,
  pdfreport = FALSE,
  pdfreport.file = "report.pdf"
)

Value

No return value

Arguments

x

The object returned by the 'phylter()' function.

file

Name of the file where to write the text summary of the phylter output. If "" (the default), write.phylyer() prints to the standard output.

include.discarded

Logical. If TRUE (the default) the elements discarded before the analysis are still in the list of Outliers in the output. Useful for cleaning datasets after a phylter analysis.

pdfreport

Logical. Should a full report of the phylter analysis

pdfreport.file

If report=TRUE, name of the pdf file where the report is written. Default to report.pdf

Examples

data(carnivora) 
res <- phylter(carnivora, parallel = FALSE)
# write a full report to the standard output
write.phylter(res)