dynamic-beast 1.1.3

No project description provided

Dynamic BEAST

This command line tool can be used to create a dynamic version of BEAST 2 XML files. This dynamic XML file can be used to set BEAST parameters at runtime, which can be useful for testing different configurations or quickly modifying parameters without having to edit the XML file.

Install

Install dynamic-beast with pip (requires python -V >= 3.6.2).

pip install dynamic-beast

Usage

Give dynamic-beast the path to a BEAST2 XML file and specify where to save the dynamic XML file (if outfile is not specified XML will be printed to screen).

dynamic-beast --outfile dynamic_BEAST.xml BEAST.xml

This will produce a dynamic_BEAST.xml file that can be used as standard in a BEAST analysis.

beast dynamic_BEAST.xml

To modify parameters at runtime use the beast definitions option -D.

# change the ChainLength to 1000. 
beast -D 'mcmc.ChainLength=1000' dynamic_BEAST.xml

Multiple definitions can be passed at the same time.

# change the treelog and tracelog sampling freq to 10000. 
beast -D 'treelog.logEvery=10000,tracelog.logEvery=10000' dynamic_BEAST.xml

Explanation

The dynamic-beast tool replaces all the parameter values in the XML file with the $(id.key=value) format. The value variable is the default value that was initially specified in the XML file. However, the value can be redefined when running a BEAST analysis by making use of the BEAST2 definitions option (-D) that allows for user specified values.

To ensure reproducibility you should recreate static XML files of runs using dynamic parameters, this can be achieved using the -DFout argument e.g., beast -D ‘clockRate=0.0002’ -DFout static_BEAST.xml dynamic_BEAST.xml.