traitlab
TraitLab: a Matlab toolbox for fitting and simulating binary tree-like data
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: wiley.com -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.1%) to scientific vocabulary
Keywords
Repository
TraitLab: a Matlab toolbox for fitting and simulating binary tree-like data
Basic Info
- Host: GitHub
- Owner: traitlab-mcmc
- Language: MATLAB
- Default Branch: master
- Homepage: https://sites.google.com/site/traitlab/home
- Size: 4.81 MB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
TraitLab
Description
TraitLab implements the stochastic Dollo model for simulating and fitting binary data on trees using Markov chain Monte Carlo methods.
- Original paper: Nicholls and Gray (2008)
- Missing data and rate heterogeneity: Ryder and Nicholls (2011)
- Lateral trait transfer: Kelly and Nicholls (2017)
- Couplings to diagnose convergence and construct unbiased estimators: Kelly, Ryder and Clarté (2021)
See the TraitLab website for an overview of TraitLab's features and related publications. The manual contains a full description of the tools in TraitLab and a step-by-step tutorial for running an analysis.
Requirements
TraitLab runs in Matlab and requires its Statistics and Machine Learning toolbox.
The TraitLab source code can be downloaded from GitHub, no further installation steps are required unless the borrowing model is being run: see README in the borrowing directory for more details.
Please get in touch if you have any issues.
Analysis
TraitLab reads Nexus-formatted data in a .nex file.
A startup file sets up the path when Matlab is started at the top level of the TraitLab directory.
To run an experiment using the GUI:
- Start Matlab in the TraitLab folder or start Matlab, navigate to the TraitLab folder and execute
startupin the Matlab commmand window. - Execute
TraitLabin the Matlab command window to open the analysis GUI. - Load data and set the parameters of the experiments then click start.
TraitLab will write the settings (.par) and output files to the specified directory.
To analyse samples at the end of a run, open the analysis GUI from the toolbar in the main TraitLab GUI.
Alternatively, experiments can be launched from parameter files.
matlab
batchTraitLab('<path to .par file>');
This allows experiments to be run from the Matlab command window or from the command line.
See the manual for a full description.
Example
The example folder contains a synthetic data set and .par files to run single- and coupled-chain experiments. The README file within describes how to run the experiments.
Owner
- Name: traitlab-mcmc
- Login: traitlab-mcmc
- Kind: organization
- Website: https://sites.google.com/site/traitlab/home
- Repositories: 1
- Profile: https://github.com/traitlab-mcmc
Citation (CITATION.cff)
# YAML 1.2
---
authors:
- family-names: Kelly
given-names: "L.J."
orcid: "https://orcid.org/https://orcid.org/0000-0003-4653-9303"
- family-names: Nicholls
given-names: "G.K."
- family-names: Ryder
given-names: "R.J."
- family-names: Welch
given-names: "D."
cff-version: "1.2.0"
message: "If you use this software, please cite the preferred-citation."
repository-code: "https://github.com/traitlab-mcmc/TraitLab"
title: TraitLab
preferred-citation:
authors:
- family-names: "Kelly"
given-names: "Luke J."
- family-names: Nicholls
given-names: "Geoff K."
- family-names: "Ryder"
given-names: "Robin J."
- family-names: "Welch"
given-names: "David"
title: "TraitLab: a Matlab package for fitting and simulating binary tree-like data"
type: article
year: 2023
journal: "arXiv:2308.09060"