Skip to content

TGuillerme/treats

Repository files navigation

R-CMD-check codecov Project Status: Active – The project has reached a stable, usable state and is being actively developed. develVersion DOI

minimal R version CRAN status CRAN downloads

treats: TREes And Traits Simulation

What is treats?

With treats you can simulate phylogenetic trees and traits at the same time. This has can be done with other great packages such as FossilSim, PETER, RPANDA, TreeSim but treats is designed to be super modular so you can simulate trees and traits the way you want! Basically you can simulate a tree depending on the traits of the tip taxa, or not, or something else! And you can also add events to your simulations that can modify either the tree, the traits or both (or the way they influence each other). This can be useful for simulating mass extinctions, species competition, traitspace saturation or whatever you can think of.

Check out the paper associated with the first version of this package.

Installing treats

if(!require(devtools)) install.packages("devtools")
library(devtools)
install_github("TGuillerme/treats")
library(treats)

How does it work?

The detailed manual is available here. Alternatively, you can use this cheat sheet if you're already familiar with the package.

Latest patch notes

Patch notes can be seen here.

Workshop

You can get the workshop R markdown document here or download it directly from here (right click + save as) or visualise it in html from here. If you have some time you can also watch this MEE Live! video (55 minutes though!).

Simulation templates

If you need some inspiration, you can browse through this gallery of simulation templates.

If you want to help your fellow or future treats users, please share your template as a simulation template issue. Don't worry about typos, language or format. The important part is that you're happy to share your template and that it's clear and simple to other users!

Authors and contributors