Skip to content
R package to generate the same BEAST2 XML parameter files as generated by BEAUti 2
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
doc
inst
man
pics Updated docs [skip ci] Sep 11, 2018
scripts
tests
vignettes
.Rbuildignore
.gitignore Vignette works, fix #80 Feb 15, 2019
.travis.yml
CONTRIBUTING.md
DESCRIPTION
LICENSE Initial commit Mar 8, 2016
NAMESPACE Exported 'is_mrca_prior' May 21, 2019
NEWS.md
README.md
appveyor.yml Use AppVeyor Apr 13, 2018
beautier.Rproj
codemeta.json
install_beast2 Use BEAST 2.4.8 Mar 6, 2018
install_r_packages.R Do not need TreeSim Feb 19, 2018

README.md

beautier

Peer Review Status CRAN_Status_Badge DOI

Branch Travis CI logo AppVeyor logo Codecov logo
master Build Status AppVeyor Build Status codecov.io
develop Build Status AppVeyor Build Status codecov.io

beautier is BEAUti for R.

beautier logo

The purpose of beautier is to create a valid BEAST2 XML input file from its function arguments. In this way, a scientific pipeline using BEAST2 can be fully scripted, instead of using BEAUti's GUI.

beautier is part of the babette package suite:

  • beautier creates BEAST2 input (.xml) files.
  • beastier runs BEAST2
  • tracerer pastes BEAST2 output (.log, .trees, etc) files.

Related R packages:

  • lumier: Shiny app to help create the function call needed
  • mauricer: install BEAST2 packages

Examples

See examples.

Installation

If you use the devtools R package, this is easy:

devtools::install_github("ropensci/beautier")

FAQ

See FAQ.

Supported

  • 1 DNA alignment
  • Site models:
    • JC69
    • HKY
    • TN93
    • GTR
  • Clock models:
    • Strickt
    • Relaxed log-normal
  • Tree models:
    • Yule
    • Birth-Death
    • Coalescent Bayesian Skyline
    • Coalescent Constant Population
    • Coalescent Exponential Population

Missing features/unsupported

beautier cannot do everything BEAUti can.

Here are some missing or (yet) unsupported features:

  • Tip dating
  • Two or more DNA alignments
  • Two or more site, clock or tree models
  • Two or more MRCA priors
  • Shared site, clock and/or tree models
  • Using an amino acid alignment
  • Support for hyper parameters
  • Clock models
    • Relaxed exponential
    • Random local
  • Tree priors
    • Calibrated Yule model
    • Coalescent Extended Bayesian Skyline
  • Initialization (this is a tab that is hidden by default in BEAUti)

There is a feature I miss

See CONTRIBUTING, at Submitting use cases

I want to collaborate

See CONTRIBUTING, at 'Submitting code'

I think I have found a bug

See CONTRIBUTING, at 'Submitting bugs'

There's something else I want to say

Sure, just add an Issue. Or send an email.

External links

References

Article about babette:

FASTA files anthus_aco.fas and anthus_nd2.fas from:

  • Van Els, Paul, and Heraldo V. Norambuena. "A revision of species limits in Neotropical pipits Anthus based on multilocus genetic and vocal data." Ibis.

FASTA file G_VII_pre2003_msa.fas from:

  • Durr, PA; Wibowo, MH; Tabbu, CR; Asmara, W; Selleck, P; Wang, J; Broz, I; Graham, K.; Dimitrov, K and Afonso, C. (in preparation). Phylodynamics of Genotype VII Newcastle disease virus in Indonesia.

ropensci_footer

You can’t perform that action at this time.