BEAST v1.7.0 Parser Library (2002-2012)

Development Version (updated on 21 February 2012 NZDT)

The following is a list of valid elements in a beast file.
     required
     optional

<ACLikelihood>

Description:
This element returns an object that can calculate the likelihood of rate changes in a tree under the assumption of distributed rate changes among lineages. Specifically, each branch is assumed to draw a rate from a distribution with mean of the rate in the parent branch and the given standard deviation (the variance can be optionally proportional to branch length).
Rule:
TreeModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)
The branch rates parameter
Attribute episodic is Boolean
true if model is branch length independent, false if length-dependent.
Attribute distribution is String
The distribution to use
Element named rootRate containing:
Parameter element (exactly one)
The root rate parameter
Element named variance containing:
Parameter element (exactly one)
The standard deviation of the distribution

<addremoveARGEvent>

Description:
An operator that slides a subarg.
Rule:
Attribute weight is Integer
Attribute size is Double
Attribute gaussian is Boolean
Attribute swapRates is Boolean
Attribute swapTraits is Boolean
Attribute autoOptimize is Boolean
ARGModel element (exactly one)

<advancedTreeLikelihood>

Description:
This element represents the likelihood of a patternlist on a tree given the site model.
Rule:
Attribute useAmbiguities is Boolean
Attribute useScaling is Boolean
Element named tips containing:
SiteModel element (exactly one)
A siteModel that will be applied only to the tips.
Element named delta containing:
TaxonList element (zero or one)
A set of taxa to which to apply the delta model to
Parameter element (zero or one)
A parameter that specifies the amount of extra substitutions per site at each tip.
Element named clade containing:
Attribute includeStem is Boolean
determines whether or not the stem branch above this clade is included in the siteModel.
TaxonList element (exactly one)
A set of taxa which defines a clade to apply a different site model to
SiteModel element (exactly one)
A siteModel that will be applied only to this clade
PatternList element (exactly one)
TreeModel element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (zero or one)

<alignment>

Description:
This element represents an alignment of molecular sequences.
Rule:
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The data type
DataType element (exactly one)
Sequence elements (one or more)
Example:
<!-- An alignment of three short DNA sequences -->
<alignment missing="-?" dataType="nucleotide">
  <sequence>
    <taxon idref="taxon1"/>
    ACGACTAGCATCGAGCTTCG--GATAGCAGGC
  </sequence>
  <sequence>
    <taxon idref="taxon2"/>
    ACGACTAGCATCGAGCTTCGG-GATAGCATGC
  </sequence>
  <sequence>
    <taxon idref="taxon3"/>
    ACG?CTAGAATCGAGCTTCGAGGATAGCATGC
  </sequence>
</alignment>

<alignmentChunkOperator>

Description:
This element represents an operator that re-aligns a small chunk of an alignment.
Rule:
Attribute weight is Double
Attribute iP is Double
tuning probability, values near zero resamples entire alignment and near 1.0 resamples single columns.
Attribute exponent is Double
tuning parameter, value of 1.0 samples random alignments, large values (e.g. 2.7) sample alignment peaked around 'best' alignment
Attribute gapPenalty is Double
tuning parameter, must be negative, large values penalize gaps more in the alignment proposal.
TKF91Likelihood element (exactly one)

<alloppNetworkPriorModel>

Description:
Model for speciation, extinction, hybridization in allopolyploid network.
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named eventRate containing:
Parameter element (exactly one)

<alloppspecies>

Description:
Binds taxa to gene trees with information about possibly allopolyploid species.
Rule:
Attribute minGeneNodeHeight is Double
AlloppSpeciesBindings$ApSpInfo elements ( or more)
Element named geneTrees containing:
TreeModel elements (zero or more)
Element named gtree containing:
Attribute popfactor is Double
TreeModel element (exactly one)

<alloppSpeciesNetwork>

Description:
Species network with population sizes along branches
Rule:
Attribute oneHybridization is Boolean
AlloppSpeciesBindings element (exactly one)
Element named sppSplitPopulations containing:
Attribute value is Double
Parameter element (exactly one)

<alsTreeLikelihood>

Description:
This element represents the likelihood of a patternlist on a tree given the site model.
Rule:
Attribute useAmbiguities is Boolean
Attribute storePartials is Boolean
Attribute integrateGainRate is Boolean
Element named immigrationRate containing:
Parameter element (exactly one)
PatternList element (exactly one)
TreeModel element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (zero or one)
Element named observationProcess containing:
Attribute type is String
Attribute taxon is String

<aminoAcidModel>

Description:
An empirical amino acid substitution model.
Rule:
Attribute type ∈ {blosum62, dayhoff, JTT, mtREV, cpREV, WAG, FLU}
The type of empirical amino-acid rate matrix
Element named frequencies containing:
FrequencyModel element (exactly one)
If the frequencies are omitted than the empirical frequencies associated with the selected model are used.

<ancestralTrait>

Description:
A statistic that has as its value the height of the most recent common ancestor of a set of taxa in a given tree
Rule:
Attribute name is string
A name for this statistic primarily for the purposes of logging
Attribute traitName is string
The name of the trait to log
TreeModel element (exactly one)
TreeTraitProvider element (exactly one)
Element named mrca containing:
Taxa element (exactly one)
The MRCA to reconstruct the trait at (default root node)

<ancestralTrait>

Description:
A statistic that has as its value the height of the most recent common ancestor of a set of taxa in a given tree
Rule:
Attribute name is string
A name for this statistic primarily for the purposes of logging
Attribute traitName is string
The name of the trait to log
TreeModel element (exactly one)
TreeTraitProvider element (exactly one)
Element named mrca containing:
Taxa element (exactly one)
The MRCA to reconstruct the trait at (default root node)

<ancestralTreeLikelihood>

Description:
This element represents the likelihood of a patternlist on a tree given the site model.
Rule:
Attribute useAmbiguities is Boolean
Attribute storePartials is Boolean
Attribute stateTagName is String
Attribute forceRescaling is Boolean
Attribute useMAP is Boolean
Attribute useMarginalLikelihood is Boolean
PatternList element (exactly one)
TreeModel element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (zero or one)
SubstitutionModel element (exactly one)

<antigenicTraitLikelihood>

Description:
Provides the likelihood of immunological assay data such as Hemagglutinin inhibition (HI) given vectors of coordinatesfor viruses and sera/antisera in some multidimensional 'antigenic' space.
Rule:
Attribute fileName is String
The name of the file containing the assay table
Attribute virusMapFile is String
The name of the file containing the virus to serum map
Attribute assayMapFile is String
The name of the file containing the assay to serum map
Attribute mdsDimension is Integer
The dimension of the space for MDS
Attribute log2Transform is Boolean
Whether to log2 transform the data
Attribute virusLocations is String;
A list of virus names to create location statistics for
Element named tipTrait containing:
CompoundParameter element (exactly one)
The parameter of tip locations from the tree
Element named locations containing:
MatrixParameter element (exactly one)
Element named mdsPrecision containing:
Parameter element (exactly one)

<anyTipObservationProcess>

Description:
This element represents an instance of the AnyTipObservationProcess for ALSTreeLikelihood calculations
Rule:
TreeModel element (exactly one)
PatternList element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (exactly one)
Element named deathRate containing:
Parameter element (exactly one)
Element named immigrationRate containing:
Parameter element (exactly one)

<apsp>

Description:
A diploid or allopolyploid species made of individuals
Rule:
Attribute ploidylevel is Double
AlloppSpeciesBindings$Individual elements (one or more)

<apspCoalescent>

Description:
Likelihood of a set of gene trees embedded in a allopolyploid species network.
Rule:
AlloppSpeciesBindings element (exactly one)
AlloppSpeciesNetworkModel element (exactly one)

<apspNetworkPrior>

Description:
Prior for an allopolyploid species network.
Rule:
Element named model containing:
AlloppNetworkPriorModel element (exactly one)
Element named apspNetwork containing:
AlloppSpeciesNetworkModel element (exactly one)

<arbitraryBranchRates>

Description:
This element returns an arbitrary rate model.The branch rates are drawn from an arbitrary distribution determine by the prior.
Rule:
TreeModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)
The rate parameter
Attribute reciprocal is Boolean

<argCoalescentLikelihood>

Description:
A coalescent likelihood for an ARG model
Rule:
Element named populationSize containing:
Parameter element (exactly one)
Element named recombinationRate containing:
Parameter element (exactly one)
Element named argModel containing:
ARGModel element (exactly one)
Attribute ancestralRestriction is Boolean

<argDiscretizedBranchRates>

Description:
This element returns an discretized relaxed clock model.The branch rates are drawn from a discretized parametric distribution.
Rule:
ARGModel element (exactly one)
Element named distribution containing:
ParametricDistributionModel element (exactly one)
The distribution model for rates among branches
Attribute numRateCategories is Integer

<ARGEventOperator>

Description:
An operator that slides a subarg.
Rule:
Attribute addProbability is Double
The probability that the operator adds a new reassortment event
Attribute jointPartitioning is Boolean
Attribute tossSize is Integer
Attribute addProbability is Double
Attribute autoOptimize is Boolean
Attribute weight is Integer
ARGModel element (exactly one)
ARGPartitionLikelihood element (exactly one)
ARGRatePrior element (zero or one)
Element named internalNodes containing:
CompoundParameter element (exactly one)
Element named internalNodesPlusRoot containing:
CompoundParameter element (exactly one)
Element named nodeRates containing:
CompoundParameter element (exactly one)

<argLocalClock>

Description:
null

<argTreeModel>

Description:
This element represents a model of the tree. The tree model includes and attributes of the nodes including the age (or height) and the rate of evolution at each node in the tree.
Rule:
Attribute partitionType ∈ {reassortment, recombination}
Describes the partition structure of the model
Tree element (exactly one)
Element named rootHeight containing:
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named nodeHeights containing:
Attribute rootNode is Boolean
If true the root height is included in the parameter
Attribute internalNodes is Boolean
If true the internal node heights (minus the root) are included in the parameter
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Example:
<!-- the tree model as special sockets for attaching parameters to various aspects of the tree     -->
<!-- The treeModel below shows the standard setup with a parameter associated with the root height -->
<!-- a parameter associated with the internal node heights (minus the root height) and             -->
<!-- a parameter associates with all the internal node heights                                     -->
<!-- Notice that these parameters are overlapping                                                  -->
<!-- The parameters are subsequently used in operators to propose changes to the tree node heights -->
<treeModel id="treeModel1">
	<tree idref="startingTree"/>
	<rootHeight>
		<parameter id="treeModel1.rootHeight"/>
	</rootHeight>
	<nodeHeights internalNodes="true" rootNode="false">
		<parameter id="treeModel1.internalNodeHeights"/>
	</nodeHeights>
	<nodeHeights internalNodes="true" rootNode="true">
		<parameter id="treeModel1.allInternalNodeHeights"/>
	</nodeHeights>
</treeModel>

<argNarrowExchange>

Description:
This element represents a narrow exchange operator. This operator swaps a random subtree with its uncle.
Rule:
Attribute weight is Integer
ARGModel element (exactly one)

<argPartitionOperator>

Description:
An operator that picks a new partitioning uniformly at random.
Rule:
Attribute weight is Integer
Attribute tossSize is Integer
Attribute tossAll is Boolean
ARGModel element (exactly one)

<argRatePrior>

Description:
null

<argReassortmentNodeCount>

Description:
A statistic that returns the number of reassortment nodes in an ARG
Rule:
Attribute name is string
A name for this statistic for the purpose of logging
ARGModel element (exactly one)

<argSubtreeSlide>

Description:
An operator that slides a subtree.
Rule:
Attribute weight is Integer
Attribute size is Double
Attribute gaussian is Boolean
Attribute swapRates is Boolean
Attribute swapTraits is Boolean
Attribute autoOptimize is Boolean
ARGModel element (exactly one)

<argSwapOperator>

Description:
Swaps nodes on a tree
Rule:
Attribute weight is Integer
Attribute type ∈ {bifurcationSwap, reassortmentSwap, dualSwap, fullSwap, narrowSwap}
The mode of the operator
ARGModel element (exactly one)

<argTimingStatistic>

Description:
Rule:
ARGModel element (exactly one)
Attribute name is String

<argTotalLengthStatistic>

Description:
null

<argTraceAnalysis>

Description:
Analyses and reports on a trace consisting of trees.
Rule:
Attribute fileName is string
name of a tree log file
Attribute burnIn is Integer

<argTreeCount>

Description:
Provides number of distinct loci trees
Rule:
ARGModel element (exactly one)

<argTreeLikelihood>

Description:
This element represents the likelihood of a patternlist on a tree given the site model.
Rule:
Attribute useAmbiguities is Boolean
Attribute storePartials is Boolean
Attribute useScaling is Boolean
PatternList element (exactly one)
ARGModel element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (zero or one)

<argTreeModel>

Description:
This element represents a model of the tree. The tree model includes and attributes of the nodes including the age (or height) and the rate of evolution at each node in the tree.
Rule:
Attribute partitionType ∈ {reassortment, recombination}
Describes the partition structure of the model
Tree element (exactly one)
Element named rootHeight containing:
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named nodeHeights containing:
Attribute rootNode is Boolean
If true the root height is included in the parameter
Attribute internalNodes is Boolean
If true the internal node heights (minus the root) are included in the parameter
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Example:
<!-- the tree model as special sockets for attaching parameters to various aspects of the tree     -->
<!-- The treeModel below shows the standard setup with a parameter associated with the root height -->
<!-- a parameter associated with the internal node heights (minus the root height) and             -->
<!-- a parameter associates with all the internal node heights                                     -->
<!-- Notice that these parameters are overlapping                                                  -->
<!-- The parameters are subsequently used in operators to propose changes to the tree node heights -->
<treeModel id="treeModel1">
	<tree idref="startingTree"/>
	<rootHeight>
		<parameter id="treeModel1.rootHeight"/>
	</rootHeight>
	<nodeHeights internalNodes="true" rootNode="false">
		<parameter id="treeModel1.internalNodeHeights"/>
	</nodeHeights>
	<nodeHeights internalNodes="true" rootNode="true">
		<parameter id="treeModel1.allInternalNodeHeights"/>
	</nodeHeights>
</treeModel>

<argUniformPrior>

Description:
A uniform prior for an ARG model
Rule:
ARGModel element (exactly one)

<argWideExchange>

Description:
This element represents a wide exchange operator. This operator swaps two random subtrees.
Rule:
Attribute weight is Integer
ARGModel element (exactly one)

<array>

Description:
This element returns an array of the objects it contains.
Rule:
Object elements (one or more)
Objects to be put in an array

<ascertainedPatterns>

Description:
A weighted list of the unique site patterns (unique columns) in an alignment.
Rule:
Attribute from is Integer
The site position to start at, default is 1 (the first position)
Attribute to is Integer
The site position to finish at, must be greater than from, default is length of given alignment
Attribute every is Integer
Determines how many sites are selected. A value of 3 will select every third site starting from from, default is 1 (every site)
Element named taxonList containing:
TaxonList element (exactly one)
Alignment element (exactly one)

<ASYMQUADModel>

Description:
This element represents an instance of the stepwise mutation model of microsatellite evolution.
Rule:
Microsatellite element (exactly one)
FrequencyModel element (zero or one)
Element named ExpansionConstant containing:
Parameter element (exactly one)
Element named ContractionConstant containing:
Parameter element (exactly one)
Element named ExpansionLinear containing:
Parameter element (exactly one)
Element named ContractionLinear containing:
Parameter element (exactly one)
Element named ExpansionQuad containing:
Parameter element (exactly one)
Element named ContractionQuad containing:
Parameter element (exactly one)
Attribute isSubmodel is Boolean

<attr>

Description:
This element represents a name/value pair.
Rule:
Attribute name is string
The name to give to this attribute
Object element (exactly one)

<attributePatterns>

Description:
A site pattern defined by an attribute in a set of taxa.
Rule:
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The data type
DataType element (exactly one)
Attribute attribute is String
TaxonList element (exactly one)
The taxon set

<attributes>

Description:
This element represents an array of name/value pairs.
Rule:
Attribute names is String;
Attribute values is String;

<avgPosteriorIBDReporter>

Description:
This element represents a reporter for average expected number of tips ibd conditional on observed patterns.
Rule:
TreeModel element (exactly one)
BranchRateModel element (zero or one)
AbstractSubstitutionModel element (exactly one)
Parameter element (exactly one)
NodePosteriorTreeLikelihood element (exactly one)

<ancestralTreeLikelihood>

Description:
This element represents the likelihood of a patternlist on a tree given the site model.
Rule:
Attribute useAmbiguities is Boolean
Attribute storePartials is Boolean
Attribute stateTagName is String
Attribute forceRescaling is Boolean
Attribute useMAP is Boolean
Attribute useMarginalLikelihood is Boolean
PatternList element (exactly one)
TreeModel element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (zero or one)
SubstitutionModel element (exactly one)

<complexSubstitutionModel>

Description:
A general reversible model of sequence substitution for any data type with stochastic variable selection.
Rule:
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The type of sequence data
DataType element (exactly one)
Attribute randomizeIndicator is Boolean
Element named rootFrequencies containing:
FrequencyModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)
Element named rateIndicator containing:
Parameter element (exactly one)
Attribute normalize is Boolean
Attribute maxConditionNumber is Double
Attribute mustBeConnected is Boolean
Attribute maxIterations is Integer
Attribute checkConditioning is Boolean

<DirichletSiteModel>

Description:
A SiteModel that has Dirichlet distributed rates across sites
Rule:
Element named substitutionModel containing:
SubstitutionModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)

<frequencyModel>

Description:
A model of equilibrium base frequencies.
Rule:
Attribute normalize is Boolean
PatternList element (zero or one)
Initial value
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The type of sequence data
DataType element (exactly one)
Element named frequencies containing:
Parameter element (exactly one)

<siteModel>

Description:
A SiteModel that has a gamma distributed rates across sites
Rule:
Element named substitutionModel containing:
SubstitutionModel element (exactly one)
One of:
Element named mutationRate containing:
Parameter element (exactly one)
Element named relativeRate containing:
Parameter element (exactly one)
Element named gammaShape containing:
Attribute gammaCategories is Integer
Parameter element (exactly one)
Element named proportionInvariant containing:
Parameter element (exactly one)

<benchmarker>

Description:
This element runs a benchmark on a series of likelihood calculators.
Rule:
Attribute iterationCount is Integer
Likelihood elements (one or more)

<betaPrior>

Description:
Calculates the prior probability of some data under a given beta distribution.
Rule:
Attribute shape is Double
Attribute shapeB is Double
Attribute offset is Double
Statistic elements (one or more)

<betaSplittingModel>

Description:
The beta-splitting family of tree branching models (Aldous, 1996;2001).
Rule:
Element named phi containing:
Parameter element (exactly one)
A parameter that ranges from -infinity (comb-tree) to +infinity (balanced tree)
Element named branchingTree containing:
Tree element (exactly one)

<biasedMultivariateDiffusionModel>

Description:
Describes a multivariate normal diffusion process.
Rule:
Element named precisionMatrix containing:
MatrixParameter element (exactly one)
Element named biasParameter containing:
Parameter element (exactly one)

<bifractionalDiffusionModel>

Description:
Describes a bivariate diffusion process using a bifractional random walk
Rule:
Element named alpha containing:
Parameter element (exactly one)
Element named beta containing:
Parameter element (exactly one)

<binaryCovarionModel>

Description:
A covarion substitution model on binary data and a hidden rate state with two rates.
Rule:
Element named frequencies containing:
Parameter element (exactly one)
Element named hiddenFrequencies containing:
Parameter element (exactly one)
Element named alpha containing:
Parameter element (zero or one)
Element named switchingRate containing:
Parameter element (zero or one)

<binarySubstitutionModel>

Description:
A general reversible model of sequence substitution for binary data type.
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)

<binomialLikelihood>

Description:
Calculates the likelihood of some data given some parametric or empirical distribution.
Rule:
Element named trials containing:
Parameter element (exactly one)
Element named proportion containing:
Parameter element (exactly one)
Element named counts containing:
Attribute values is Integer;

<birthDeathEpidemiology>

Description:
Stadler et al (2011) model of epidemiology.
Rule:
Element named origin containing:
Parameter element (exactly one)
The origin of the infection, x0 > tree.rootHeight
Element named R0 containing:
Parameter element (exactly one)
Element named recoveryRate containing:
Parameter element (exactly one)
Element named samplingProbability containing:
Parameter element (exactly one)
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<birthDeathModel>

Description:
Gernhard (2008) model of speciation (equation at bottom of page 19 of draft).
Rule:
Attribute type is String
Attribute conditionalOnRoot is Boolean
Element named birthMinusDeathRate containing:
Parameter element (exactly one)
Element named relativeDeathRate containing:
Parameter element (exactly one)
Element named sampleProbability containing:
Parameter element (exactly one)
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<birthDeathSerialSampling>

Description:
Stadler et al (2010) model of speciation.
Rule:
Attribute type is String
Attribute hasFinalSample is Boolean
Element named origin containing:
Parameter element (exactly one)
The origin of the infection, x0 > tree.rootHeight
Element named birthRate containing:
Parameter element (exactly one)
One of:
Element named deathRate containing:
Parameter element (exactly one)
Element named relativeDeathRate containing:
Parameter element (exactly one)
Element named psi containing:
Parameter element (exactly one)
Element named sampleBecomesNonInfectiousProb containing:
Parameter element (exactly one)
Element named sampleProbability containing:
Parameter element (exactly one)
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<bitFlipInSubstitutionModelOperator>

Description:
This element returns a bit-flip operator on a given indicatorParameter.
Rule:
Attribute weight is Double
Attribute scaleFactor is Double
Attribute autoOptimize is Boolean
Parameter element (zero or one)

<bitFlipOperator>

Description:
This element returns a bit-flip operator on a given parameter.
Rule:
Attribute weight is Double
Attribute usesPriorOnSum is Boolean
Parameter element (exactly one)

<bitMoveOperator>

Description:
This element returns a bit-move operator on a given parameter.
Rule:
Attribute weight is Double
Attribute numBitsToMove is Integer
Element named bits containing:
Parameter element (exactly one)
Element named values containing:
Parameter element (exactly one)
values parameter

<bitSwapOperator>

Description:
This element returns a bit-swap operator on a given parameter and data.
Rule:
Attribute weight is Double
Attribute radius is Double
Element named data containing:
Statistic element (exactly one)
Element named indicators containing:
Statistic element (exactly one)

<booleanLikelihood>

Description:
A function that log likelihood of a set of boolean statistics. If all the statistics are true then it returns 0.0 otherwise -infinity.
Rule:
BooleanStatistic elements (one or more)

<branchDirections>

Description:
null
Rule:

<branchingLikelihood>

Description:
This element represents the likelihood of the tree given the demographic function.
Rule:
Element named model containing:
BranchingModel element (exactly one)
Element named branchingTree containing:
TreeModel element (exactly one)

<branchMagnitudes>

Description:
null
Rule:
Attribute scaleByLength is Boolean

<BrownianMotion>

Description:
Rule:
Attribute logUnits is Boolean
One of:
Element named sigma containing:
Double element (exactly one)
Element named sigma containing:
Parameter element (exactly one)
VariableDemographicModel element (exactly one)

<cachedPrior>

Description:
Calculates a cached likelihood of some data given some parametric or empirical distribution.
Rule:
AbstractDistributionLikelihood element (exactly one)
Variable element (exactly one)

<cartogramDiffusionModel>

Description:
Describes a bivariate diffusion process using cartogram distances.
Rule:
Parameter element (exactly one)
Attribute cartogramFileName is String
Attribute xGridSize is Integer
Attribute yGridSize is Integer
Element named boundingBox containing:
Attribute minX is Double
Attribute maxX is Double
Attribute minY is Double
Attribute maxY is Double

<cataclysm>

Description:
A demographic model of exponential growth.
Rule:
Element named populationSize containing:
Parameter element (exactly one)
Element named growthRate containing:
Parameter element (exactly one)
The rate of exponential growth before the cataclysmic event.
Element named spikeFactor containing:
Parameter element (exactly one)
The factor larger the population size was at its height.
Element named timeOfCataclysm containing:
Parameter element (exactly one)
The time of the cataclysmic event that lead to exponential decline.
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<categorySiteModel>

Description:
A SiteModel that has a gamma distributed rates across sites
Rule:
Element named substitutionModel containing:
SubstitutionModel element (exactly one)
Element named mutationRate containing:
Parameter element (exactly one)
Element named rates containing:
Attribute relativeTo is Integer
Parameter element (exactly one)
Element named categories containing:
Attribute values is String
Attribute states is String

<centeredScale>

Description:
A centered-scale operator. This operator scales the the values of a multi-dimensional parameter so as to perserve the mean. It does this by expanding or conrtacting the parameter values around the mean.
Rule:
Attribute weight is Double
Attribute scaleFactor is Double
Attribute autoOptimize is Boolean
Parameter element (exactly one)

<circle>

Description:
This element represents a regular circle polygon.
Rule:
Attribute latitude is Double
Attribute longitude is Double
Attribute radius is Double
Attribute numberOfPoints is Integer

<clusterSingleMoveOperator>

Description:
An operator that moves single elements between clusters.
Rule:
Attribute weight is Double
Parameter element (exactly one)

<clusterSplitMergeOperator>

Description:
An operator that splits and merges clusters.
Rule:
Attribute weight is Double
Parameter element (exactly one)
Element named locations containing:
MatrixParameter element (exactly one)

<cNcSPerSiteAnalysis>

Description:
Performs a trace analysis of N and S counts.
Rule:
Attribute cutoff is Double
Attribute burnin is Integer
Attribute includePValues is Boolean
Attribute includeSymbol is Boolean
Attribute includeClassification is Boolean
Attribute simulationOutcome is Boolean
Attribute siteSimulation is String
Attribute separator is String

<cNcSTodNdSPerSiteAnalysis>

Description:
Performs a trace analysis of N and S counts.
Rule:
Attribute fileNameCN is String
Attribute fileNameCS is String
Attribute cutoff is Double
Attribute proportion is Double
Attribute burnin is Integer
Attribute sample is Boolean
Attribute includeHPD is Boolean
Attribute includeSymbol is Boolean
Attribute includeLevel is Boolean
Attribute includeClassification is Boolean
Attribute simulationOutcome is Boolean
Attribute siteSimulation is String
Attribute test is String
Attribute separator is String

<coalescentIntervalStatistic>

Description:
Rule:
GMRFSkyrideLikelihood element (exactly one)

<coalescentLikelihood>

Description:
This element represents the likelihood of the tree given the demographic function.
Rule:
Element named model containing:
DemographicModel element (exactly one)
The demographic model which describes the effective population size over time
Element named populationTree containing:
Attribute factor is Double
TreeModel element (exactly one)
Tree(s) to compute likelihood for
Element named include containing:
Taxa element (exactly one)
An optional subset of taxa on which to calculate the likelihood (should be monophyletic)
Element named exclude containing:
Taxa elements (one or more)
One or more subsets of taxa which should be excluded from calculate the likelihood (should be monophyletic)

<coalescentTree>

Description:
This element returns a simulated tree under the given demographic model.
Rule:
Attribute rescaleHeight is Double
Attempt to rescale the tree to the given root height
Attribute rootHeight is Double
Tree elements (zero or more)
TaxonList elements (zero or more)
Element named constrainedTaxa containing:
TaxonList elements (zero or more)
Element named tmrca containing:
TaxonList elements (zero or more)
DemographicModel element (exactly one)

<colouredNarrowExchange>

Description:
This element represents a narrow exchange operator. This operator swaps a random subtree with its uncle.
Rule:
Attribute weight is Double
TreeModel element (exactly one)
ColourSamplerModel element (exactly one)

<colouredOperator>

Description:
This element represents an arbitrary operator immediately followed by a re-colouring of the tree
Rule:
MCMCOperator element (exactly one)
ColourSamplerModel element (exactly one)

<colouredSubtreeSlide>

Description:
An operator that slides a subtree.
Rule:
Attribute weight is Double
Attribute size is Double
Attribute gaussian is Boolean
Attribute swapRates is Boolean
Attribute swapTraits is Boolean
Attribute autoOptimize is Boolean
TreeModel element (exactly one)
ColourSamplerModel element (exactly one)

<colouredWideExchange>

Description:
This element represents a wide exchange operator. This operator swaps two random subtrees.
Rule:
Attribute weight is Double
ColourSamplerModel element (exactly one)
TreeModel element (exactly one)

<colourSamplerModel>

Description:
This element represents a likelihood function for transmission.
Rule:
One of:
Element named colours containing:
Taxa elements (one or more)
Taxa for each subsequent colour (after 0).
Alignment element (exactly one)
The alignment.
TreeModel element (exactly one)
The tree.
MigrationModel element (exactly one)
The migration model.
MetaPopulationModel element (exactly one)
The metapopulation model,

<column>

Description:
Specifies formating options for one or more columns in a log file.
Rule:
Attribute label is string
The label of the column. If this is specified and more than one statistic is in this column, then the label will be appended by the index of the statistic to create individual column names
Attribute sf is Integer
Attribute dp is Integer
Attribute width is Integer
Attribute format is String
Object elements (one or more)

<compatibilityStatistic>

Description:
A statistic that returns true if a pair of trees are compatible
Rule:
Attribute name is string
A name for this statistic for the purpose of logging
Tree element (exactly one)
Element named compatibleWith containing:
Tree element (exactly one)
Tree element (exactly one)

<complexSubstitutionModel>

Description:
A general reversible model of sequence substitution for any data type with stochastic variable selection.
Rule:
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The type of sequence data
DataType element (exactly one)
Attribute randomizeIndicator is Boolean
Element named rootFrequencies containing:
FrequencyModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)
Element named rateIndicator containing:
Parameter element (exactly one)
Attribute normalize is Boolean
Attribute maxConditionNumber is Double
Attribute mustBeConnected is Boolean
Attribute maxIterations is Integer
Attribute checkConditioning is Boolean

<compoundBranchRateModel>

Description:
This element provides a strict clock model. All branches have the same rate of molecular evolution.
Rule:
BranchRateModel elements (one or more)
The component branch rate models

<compoundLikelihood>

Description:
A likelihood function which is simply the product of its component likelihood functions.
Rule:
Attribute threads is Integer
Likelihood elements (one or more)

<compoundParameter>

Description:
A multidimensional parameter constructed from its component parameters.
Rule:
Parameter elements (one or more)

<compoundSymmetricMatrix>

Description:
A diagonal matrix parameter constructed from its diagonals.
Rule:
Element named diagonal containing:
Parameter element (exactly one)
Element named offDiagonal containing:
Parameter element (exactly one)
Attribute asCorrelation is Boolean

<constantExponential>

Description:
A demographic model of constant population size followed by exponential growth.
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named populationSize containing:
Parameter element (exactly one)
Element named growthPhaseStartTime containing:
Parameter element (exactly one)
One of:
Element named growthRate containing:
Parameter element (exactly one)
A value of zero represents a constant population size, negative values represent decline towards the present, positive numbers represents exponential growth towards the present. A random walk operator is recommended for this parameter with a starting value of 0.0 and no upper or lower limits.
Element named doublingTime containing:
Parameter element (exactly one)
This parameter determines the doubling time.

<constantLogistic>

Description:
A demographic model of constant population size followed by logistic growth.
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named populationSize containing:
Parameter element (exactly one)
Element named ancestralPopulationSize containing:
Parameter element (exactly one)
Element named growthRate containing:
Parameter element (exactly one)
Element named shape containing:
Parameter element (exactly one)
Attribute alpha is Double

<constantMigrationModel>

Description:
A migration model representing constant migration rates through time.
Rule:
Element named migrationRates containing:
Parameter element (exactly one)

<constantPatterns>

Description:
Creates a set of patterns for constant sites with weights as provided.
Rule:
PatternList element (exactly one)
Element named counts containing:
Parameter element (exactly one)

<constantSize>

Description:
A demographic model representing a constant population size through time.
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named populationSize containing:
Parameter element (exactly one)

<constExpConst>

Description:
A demographic model of constant population size followed by exponential growth.
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named populationSize containing:
Parameter element (exactly one)
Element named ancestralPopulationSize containing:
Parameter element (exactly one)
Element named finalPhaseStartTime containing:
Parameter element (exactly one)
One of:
Element named growthRate containing:
Parameter element (exactly one)
A value of zero represents a constant population size, negative values represent decline towards the present, positive numbers represents exponential growth towards the present. A random walk operator is recommended for this parameter with a starting value of 0.0 and no upper or lower limits.
Element named doublingTime containing:
Parameter element (exactly one)
This parameter determines the doubling time.

<continuousTraitRateModel>

Description:
This element returns an trait rate model.The branch rates are an average of the rates provided by a node trait.
Rule:
Attribute dimension is Integer
The dimension that supplies the rate
Element named rate containing:
Parameter element (exactly one)
The rate parameter
Element named ratio containing:
Parameter element (exactly one)
The ratio parameter

<convert>

Description:
Converts an alignment to the given data type.
Rule:
Alignment element (exactly one)
Attribute dataType ∈ {nucleotide, amino acid, codon, binary, hiddenCodon2, hiddenCodon3}
The type of sequence data

<coordinates>

Description:
This element represents a set of (X,Y,Z) coordinates in KML format
Rule:
String element (exactly one)

<correlation>

Description:
This element returns a precision that is the element-wise reciprocal of the child precision.
Rule:
MatrixParameter element (exactly one)
Attribute dimension1 is Integer
Attribute dimension2 is Integer

<coulombPrior>

Description:
Calculates a prior density based on the force due to electrostatic charge between particles the given distance x.
Rule:
Attribute beta is Double
One of:
Statistic elements (one or more)
Element named data containing:
Statistic elements (one or more)

<CovarionHKYModel>

Description:
A covarion HKY model.
Rule:
Element named kappa containing:
Parameter element (exactly one)
A parameter representing the transition transversion bias
Element named switchingRates containing:
Parameter element (exactly one)
A parameter representing the rate of change between the different classes
Element named hiddenClassRates containing:
Parameter element (exactly one)
A parameter representing the rates of the hidden classes relative to the first hidden class.

<covarionModel>

Description:
A covarion substitution model on binary data and a hidden rate state with two rates.
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named alpha containing:
Parameter element (zero or one)
Element named switchingRate containing:
Parameter element (zero or one)

<CSVexport>

Description:
Write tabular data as an CSV file.
Rule:
Attribute fileName is string
The name of a BEAST log file (can not include trees, which should be logged separately
Attribute separator is string
Values separator (default is tab)
Element named columns containing:
Attribute all is Boolean
Dump all columns. default is TRUE when no columns are specified, FALSE otherwise
Attribute rows is Boolean
Write data in rows (default is columns)
TabularData element (exactly one)
Element named CSVcolumn containing:
Attribute name is String;
Parameter element (exactly one)
column name
A subset of columns from one source

<ctmcScalePrior>

Description:
This element represents the prior for CTMC scale parameter.
Rule:
TreeModel element (exactly one)
Element named ctmcScale containing:
Parameter element (exactly one)

<date>

Description:
Specifies a date on a given timescale
Rule:
Attribute value is string
The value of this date
Attribute origin is string
The origin of this time scale, which must be a valid calendar date
Attribute units ∈ {units, units, days}
The units of the timescale
Attribute direction ∈ {forwards, backwards}
The direction of the timescale
Example:
<!-- a date representing 10 years in the past                                 -->
<date value="10.0" units="years" direction="backwards"/>

<!-- a date representing 300 days after Jan 1st 1989                          -->
<date value="300.0" origin="01/01/89" units="days" direction="forwards"/>

<decayingRateModel>

Description:
This element provides a clock model in which the rate of molecular evolution decays to a substitution rate in the past.
Rule:
Attribute average is Boolean
TreeModel element (exactly one)
The tree model
Element named mutationRate containing:
Parameter element (exactly one)
The mutation rate parameter
One of:
Element named proportion containing:
Parameter element (exactly one)
The proportion of neutral mutations
Element named substitutionRate containing:
Parameter element (exactly one)
The long-term substitution
Element named halfLife containing:
Parameter element (exactly one)
The half-life of a deleterious mutation

<deltaExchange>

Description:
This element returns a delta exchange operator on a given parameter.
Rule:
Attribute delta is Double
Attribute parameterWeights is Integer;
Attribute weight is Double
Attribute autoOptimize is Boolean
Attribute integer is Boolean
Parameter element (exactly one)

<deltaMixOperator>

Description:
This element returns a scale operator on a given parameter.
Rule:
Attribute delta is Double
Attribute parameterWeights is Integer;
Attribute weight is Double
Attribute autoOptimize is Boolean
Parameter element (exactly one)

<designMatrix>

Description:
A matrix parameter constructed from its component parameters.
Rule:
Attribute addIntercept is Boolean
Attribute checkIdentifiability is Boolean
Parameter elements (zero or more)
Attribute form is String
Attribute colDimension is Integer
Attribute rowDimension is Integer

<diagonalMatrix>

Description:
A diagonal matrix parameter constructed from its diagonals.
Rule:
Parameter element (exactly one)

<differenceStatistic>

Description:
This element returns a statistic that is the difference of the 2 child statistics.
Rule:
Attribute absolute is Boolean
Statistic elements (exactly 2)
The two operand statistics

<differenceStatistic>

Description:
This element returns a statistic that is the difference of the 2 child statistics.
Rule:
Attribute absolute is Boolean
Statistic elements (exactly 2)
The two operand statistics

<diffusionRateStatistic>

Description:
A statistic that returns the average of the branch rates
Rule:
Attribute name is String
Attribute greatCircleDistance is Boolean

<dirichletPrior>

Description:
Calculates the likelihood of some data under a Dirichlet distribution.
Rule:
Element named countsParameter containing:
Parameter element (exactly one)

<dirichletProcessLikelihood>

Description:
Calculates the likelihood of some items distributed into a number of classes under a Dirichlet drocess.
Rule:
Element named eta containing:
Statistic element (exactly one)
Counts of N items distributed amongst K classes
Element named chi containing:
Parameter element (exactly one)
Aggregation parameter

<dirichletProcessOperator>

Description:
An operator that picks a new allocation of an item to a cluster under the Dirichlet process.
Rule:
Attribute weight is Double
Element named chi containing:
Parameter element (exactly one)
Element named likelihood containing:
Likelihood element (exactly one)
Parameter element (exactly one)

<DirichletSiteModel>

Description:
A SiteModel that has Dirichlet distributed rates across sites
Rule:
Element named substitutionModel containing:
SubstitutionModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)

<dirtyLikelihood>

Description:
This element returns a operator that forces the entire model likelihood recomputation
Rule:
Attribute weight is Double
Likelihood element (exactly one)

<discreteAntigenicTraitLikelihood>

Description:
Provides the likelihood of immunological assay data such as Hemagglutinin inhibition (HI) given vectors of coordinatesfor viruses and sera/antisera in some multidimensional 'antigenic' space. This is a discrete classifier form of the modelwhich assigns viruses to discrete antigenic classes.
Rule:
Attribute fileName is String
The name of the file containing the assay table
Attribute virusMapFile is String
The name of the file containing the virus to serum map
Attribute assayMapFile is String
The name of the file containing the assay to serum map
Attribute mdsDimension is Integer
The dimension of the space for MDS
Attribute log2Transform is Boolean
Whether to log2 transform the data
Attribute virusLocations is String;
A list of virus names to create location statistics for
Element named clusterIndices containing:
Parameter element (exactly one)
The parameter of cluster indices for each virus/serum
Element named tipTrait containing:
CompoundParameter element (exactly one)
The parameter of tip locations from the tree
Element named locations containing:
MatrixParameter element (exactly one)
Element named mdsPrecision containing:
Parameter element (exactly one)

<discreteTraitRateModel>

Description:
This Branch Rate Model takes a discrete trait reconstruction (provided by a TreeTraitProvider) and gives the rate for each branch of the tree based on the child trait of that branch. The rates for each trait value are specified in a multidimensional parameter.
Rule:
TreeModel element (exactly one)
The tree model
One of:
All of:
TreeTraitProvider element (exactly one)
The trait provider
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The type of general data
DataType element (exactly one)
PatternList element (exactly one)
Element named rates containing:
Parameter element (exactly one)
The relative rates of states
Attribute traitIndex is Integer
Attribute traitName is String

<discretizedBranchRates>

Description:
This element returns an discretized relaxed clock model.The branch rates are drawn from a discretized parametric distribution.
Rule:
Attribute singleRootRate is Boolean
Whether only a single rate should be used for the two children branches of the root
Attribute overSampling is Integer
The integer factor for oversampling the distribution model (1 means no oversampling)
Attribute normalize is Boolean
Whether the mean rate has to be normalized to a particular value
Attribute normalizeBranchRateTo is Double
The mean rate to normalize to, if normalizing
Attribute overSampling is Integer
The integer factor for oversampling the distribution model (1 means no oversampling)
TreeModel element (exactly one)
Element named distribution containing:
ParametricDistributionModel element (exactly one)
The distribution model for rates among branches
Element named rateCategories containing:
Parameter element (exactly one)
The rate categories parameter

<discretizedLocationOperator>

Description:
This element returns a multivariate Gibbs operator on traits for possible all nodes.
Rule:
Attribute weight is Double
Attribute autoOptimize is Boolean
Attribute onlyInternalNodes is Boolean
Attribute neighborhoodSize is Integer
Attribute randomize is Boolean

<DiscretizedLociRates>

Description:
This element returns an discretized loci rate model.The loci rates are drawn from a discretized parametric distribution.
Rule:
Attribute normalize is Boolean
Whether the mean rate has to be normalized to a particular value
Attribute normalizeMeanLociRateTo is Double
The mean rate to normalize to, if normalizing
Attribute categoryCount is Integer
The number of categories that the distribution will be divided into
Element named lociRates containing:
CompoundParameter element (exactly one)
The compound parameter that contains all the loci rate parameters
Element named distribution containing:
ParametricDistributionModel element (exactly one)
The distribution model for rates among branches
Element named rateCategories containing:
Parameter element (exactly one)
The rate categories parameter

<distanceMatrix>

Description:
Constructs a distance matrix from a pattern list or alignment
Rule:
Attribute correction ∈ {none, JC, F84, SMM}
The type of distance correction used
PatternList element (exactly one)

<distributionLikelihood>

Description:
Calculates the likelihood of some data given some parametric or empirical distribution.
Rule:
Element named distribution containing:
ParametricDistributionModel element (exactly one)
Element named data containing:
Attribute from is Integer
Attribute to is Integer
Statistic elements (one or more)

<dNdSPerSiteAnalysis>

Description:
Performs a trace dN/dS analysis.
Rule:
Attribute cutoff is Double
Attribute proportion is Double
Attribute burnin is Integer
Attribute includeHPD is Boolean
Attribute includeSymbol is Boolean
Attribute includeLevel is Boolean
Attribute includeClassification is Boolean
Attribute simulationOutcome is Boolean
Attribute siteSimulation is String
Attribute test is String
Attribute separator is String
Attribute fileName is string
The traceName of a BEAST log file (can not include trees, which should be logged separately

<double>

Description:
returns a Double. If a prompt attribute exists then the user is prompted for input, otherwise the character contents of the element are returned as a Double.
Rule:
One of:
Attribute prompt is string
A message displayed to the user when entering a value for this double
Double element (exactly one)

<dummyLikelihood>

Description:
A function wraps a component model that would otherwise not be registered with the MCMC. Always returns a log likelihood of zero.
Rule:
One of:
Model element (exactly one)
A model element
Parameter element (exactly one)
A parameter

<dummyModel>

Description:
A function wraps a component model that would otherwise not be registered with the MCMC. Always returns a log likelihood of zero.
Rule:
Parameter elements (one or more)

<duplicatedParameter>

Description:
A duplicated parameter.
Rule:
Parameter element (exactly one)
Element named copies containing:
Parameter element (exactly one)

<empiricalCodonModel>

Description:
This element represents the empirical model of codon evolution.
Rule:
Attribute geneticCode ∈ {universal, vertebrateMitochondrial, yeast, moldProtozoanMitochondrial, invertebrateMitochondrial, ciliate, echinodermMitochondrial, euplotidNuclear, bacterial, alternativeYeast, ascidianMitochondrial, flatwormMitochondrial, blepharismaNuclear, noStops}
The genetic code to use
Attribute ecmDataDir is string
The directory with the ECM data file
Attribute ecmRateFile is string
The csv file with the ECM data matrix
Attribute ecmFreqFile is string
The csv file with the ECM frequency matrix
Element named omega containing:
Parameter element (exactly one)
One of:
Element named kappaTsTv containing:
Parameter element (exactly one)
Element named multiNtChange containing:
Parameter element (exactly one)
FrequencyModel element (zero or one)

<empiricalDistributionLikelihood>

Description:
Calculates the likelihood of some data given some empirically-generated distribution.
Rule:
Attribute fileName is String
Attribute splineInterpolation is Boolean
Attribute degree is Integer
Attribute inverse is Boolean
Attribute readByColumn is Boolean
Element named data containing:
Attribute from is Integer
Attribute to is Integer
Attribute offset is Double
Statistic elements (one or more)

<empiricalPiecewise>

Description:
This element represents a piecewise population model
Rule:
Element named intervalWidths containing:
Attribute values is Double;
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named populationSizes containing:
Parameter element (exactly one)
The effective population sizes of each interval.
Element named generationLength containing:
Parameter element (exactly one)
The scale factor.
Element named threshold containing:
Parameter element (exactly one)
The threshold before counts occur.
Element named lag containing:
Parameter element (exactly one)
The lag between actual population sizes and genetic diversity.

<empiricalTreeDistributionModel>

Description:
Read a list of trees from a NEXUS file.
Rule:
Attribute fileName is string
The name of a NEXUS tree file
TaxonList element (exactly one)

<empiricalTreeDistributionOperator>

Description:
Operator which switches between trees in an empirical distribution.
Rule:
Attribute weight is Double
Attribute metropolisHastings is Boolean
EmpiricalTreeDistributionModel element (exactly one)

<exponentialStatistic>

Description:
This element returns a statistic that is the element-wise exponentiation of the child statistic.
Rule:
Statistic element (exactly one)

<expansion>

Description:
A demographic model of constant population size followed by exponential growth.
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named populationSize containing:
Parameter element (exactly one)
Element named ancestralPopulationProportion containing:
Parameter element (exactly one)
One of:
Element named growthRate containing:
Parameter element (exactly one)
A value of zero represents a constant population size, negative values represent decline towards the present, positive numbers represents exponential growth towards the present. A random walk operator is recommended for this parameter with a starting value of 0.0 and no upper or lower limits.
Element named doublingTime containing:
Parameter element (exactly one)
This parameter determines the doubling time.

<expConstExp>

Description:
A demographic model of exponential growth.
Rule:
Element named populationSize containing:
Parameter element (exactly one)
Element named relativePlateauSize containing:
Parameter element (exactly one)
The size of plateau relative to modern population size.
Element named relTimeModGrowth containing:
Parameter element (exactly one)
The time spanned by modern growth phase relative to time back to start of plateau phase.
Element named plateauStartTime containing:
Parameter element (exactly one)
The time of the start of plateauPhase.
Element named ancientGrowthRate containing:
Parameter element (exactly one)
The growth rate of early growth phase
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<exponentialBranchLengthsPrior>

Description:
This element represents a tree prior assuming exponentially distributed branch lengths.
Rule:
TreeModel element (exactly one)

<exponentialDistributionModel>

Description:
A model of an exponential distribution.
Rule:
One of:
Element named mean containing:
Double element (exactly one)
Element named mean containing:
Parameter element (exactly one)
Attribute offset is Double

<exponentialGrowth>

Description:
A demographic model of exponential growth.
Rule:
Element named populationSize containing:
Parameter element (exactly one)
One of:
Element named growthRate containing:
Parameter element (exactly one)
A value of zero represents a constant population size, negative values represent decline towards the present, positive numbers represents exponential growth towards the present. A random walk operator is recommended for this parameter with a starting value of 0.0 and no upper or lower limits.
Element named doublingTime containing:
Parameter element (exactly one)
This parameter determines the doubling time.
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<exponentialLogistic>

Description:
A demographic model of constant population size followed by logistic growth.
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named populationSize containing:
Parameter element (exactly one)
Element named logisticGrowthRate containing:
Parameter element (exactly one)
Element named logisticShape containing:
Parameter element (exactly one)
Element named exponentialGrowthRate containing:
Parameter element (exactly one)
Element named transitionTime containing:
Parameter element (exactly one)
Attribute alpha is Double

<exponentialMarkovLikelihood>

Description:
A continuous state, discrete time markov chain in which each new state is an exponentially distributed variable with a mean of the previous state.
Rule:
Attribute jeffreys is Boolean
Attribute reverse is Boolean
Element named chainParameter containing:
Parameter element (exactly one)

<exponentialPrior>

Description:
Calculates the prior probability of some data under a given exponential distribution.
Rule:
One of:
Attribute scale is Double
Attribute mean is Double
Attribute offset is Double
Statistic elements (one or more)

<exponentialSawtooth>

Description:
A demographic model of succesive exponential growth and periodic population crashes.
Rule:
Element named populationSize containing:
Parameter element (exactly one)
Element named growthRate containing:
Parameter element (exactly one)
The rate of exponential growth during the growth phase.
Element named wavelength containing:
Parameter element (exactly one)
The wavelength between successive population crashes.
Element named offset containing:
Parameter element (exactly one)
The proportion of the last growth phase that is not achieved at the final sample time.
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<exponentialStatistic>

Description:
This element returns a statistic that is the element-wise exponentiation of the child statistic.
Rule:
Statistic element (exactly one)

<expressionStatistic>

Description:
This element returns a statistic that is the mean of the child statistics.
Rule:
Element named expression containing:
String element (exactly one)
Element named variables containing:
Statistic elements (one or more)

<extendedDataType>

Description:
This element represents an instance of the MutationDeathType which extends a base datatype with an additional "death" state.
Rule:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
Base datatype name
DataType element (zero or one)
Element named deathState containing:
Attribute code is String
Element named extantState containing:
Attribute code is String

<externalLengthStatistic>

Description:
A statistic that has as its value(s) the length of the external branch length(s) of a set of one or more taxa in a given tree
Rule:
TreeModel element (exactly one)
Attribute name is string
A name for this statistic primarily for the purposes of logging
Taxa element (exactly one)

<fixedColouredOperator>

Description:
This element (or a ColouredOperator) must wrap any operator that changes a parameter upon which the colouring proposal distribution depends
Rule:
MCMCOperator element (exactly one)
ColourSamplerModel element (exactly one)

<FixedNodeheightSubtreePruneRegraft>

Description:
This element represents a FNPR operator. This operator swaps a random subtree with its uncle.
Rule:
Attribute weight is Double
TreeModel element (exactly one)

<flatGeoSpatialPrior>

Description:
Calculates the likelihood of some data under a 2D geospatial distribution.
Rule:
Attribute taxon is String
Attribute inside is Boolean
Attribute union is Boolean
One of:
Attribute kmlFileName is String
Polygon2D elements (one or more)
Element named data containing:
Parameter elements (one or more)

<frequencyModel>

Description:
A model of equilibrium base frequencies.
Rule:
Attribute normalize is Boolean
PatternList element (zero or one)
Initial value
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The type of sequence data
DataType element (exactly one)
Element named frequencies containing:
Parameter element (exactly one)

<funkyPriorMixerOperator>

Description:
This element returns a random walk operator on a given parameter.
Rule:
Attribute windowSize is Double
Attribute weight is Double
Attribute autoOptimize is Boolean
Attribute boundaryCondition ∈ {reflecting, absorbing}
null
Parameter element (exactly one)
TreeModel element (exactly one)

<gammaDistributionModel>

Description:
A model of a gamma distribution.
Rule:
One of:
Element named shape containing:
Double element (exactly one)
Element named shape containing:
Parameter element (exactly one)
One of:
Element named scale containing:
Double element (exactly one)
Element named scale containing:
Parameter element (exactly one)

<gammaPrior>

Description:
Calculates the prior probability of some data under a given gamma distribution.
Rule:
Attribute shape is Double
Attribute scale is Double
Attribute offset is Double
Statistic elements (one or more)

<gammaSiteBMA>

Description:
A SiteModel that does BMA for a gamma distributed rates across sites
Rule:
Element named substitutionModel containing:
SubstitutionModel element (exactly one)
Element named mutationRate containing:
Parameter element (exactly one)
Element named logGammaShape containing:
Attribute gammaCategories is Integer
Parameter element (exactly one)
Element named logitProportionInvariant containing:
Parameter element (exactly one)
Element named modelChoose containing:
Variable element (exactly one)

<generalDataType>

Description:
Defines a general DataType for any number of states
Rule:
Identifiable elements (zero or more)
Example:
<!-- The XML for a nucleotide data type under this scheme would be -->
<generalDataType id="nucleotides">
	<state code="A"/>
	<state code="C"/>
	<state code="G"/>
	<state code="T"/>
	<alias code="U" state="T"/>
	<ambiguity code="R" states="AG"/>
	<ambiguity code="Y" states="CT"/>
	<ambiguity code="?" states="ACGT"/>
	<ambiguity code="-" states="ACGT"/>
</generalDataType>

<generalF81Model>

Description:
A general F81 model for an arbitrary number of states.
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)

<generalizedSkylineGibbsOperator>

Description:
This element returns a Gibbs operator for the joint distribution of population sizes.
Rule:
Attribute linear is Boolean
Attribute weight is Double
Attribute lower is Double
Attribute upper is Double
Attribute Jeffreys is Boolean
Attribute reverse is Boolean
Attribute exponentialMarkov is Boolean
Attribute shape is Double
BayesianSkylineLikelihood element (exactly one)
Parameter element (exactly one)

<generalizedSkyLineLikelihood>

Description:
This element represents the likelihood of the tree given the population size vector.
Rule:
One of:
Attribute linear is Boolean
Attribute type is String
Element named populationSizes containing:
Parameter element (exactly one)
Element named groupSizes containing:
Parameter element (exactly one)
Element named populationTree containing:
TreeModel element (exactly one)

<generalizedSkylinePopSizeStatistic>

Description:
The pop sizes at the given times

<generalSubstitutionModel>

Description:
A general reversible model of sequence substitution for any data type.
Rule:
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The type of sequence data
DataType element (exactly one)
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)
Element named rateIndicator containing:
Parameter element (exactly one)
Attribute randomizeIndicator is Boolean

<GibbsPruneAndRegraft>

Description:
This element represents a Gibbs sampler implemented through a prune and regraft operator. This operator prunes a random subtree and regrafts it below a node chosen by an importance distribution which is the proportion of the likelihoods of the proposals.
Rule:
Attribute weight is Double
Attribute pruned is Boolean
TreeModel element (exactly one)

<GibbsSubtreeSwap>

Description:
This element represents a Gibbs wide exchange operator. This operator swaps two subtrees chosen to their posterior probaility.
Rule:
Attribute weight is Double
Attribute pruned is Boolean
TreeModel element (exactly one)

<glmModel>

Description:
Calculates the generalized linear model likelihood of the dependent parameters given one or more blocks of independent parameters and their design matrix.
Rule:
Attribute family is String
Attribute checkIdentifiability is Boolean
Element named dependentVariables containing:
Parameter element (exactly one)
Element named independentVariables containing:
Parameter element (zero or one)
DesignMatrix element (exactly one)
Element named indicator containing:
Parameter element (exactly one)
Element named randomEffects containing:
Parameter element (exactly one)

<glmSubstitutionModel>

Description:
A general model of sequence substitution for any data type where the rates come from the generalized linear model.
Rule:
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The type of sequence data
DataType element (exactly one)
Element named rootFrequencies containing:
FrequencyModel element (exactly one)
GeneralizedLinearModel element (exactly one)

<gmrfBivariateCurveAnalysis>

Description:
Integrates two curves
Rule:
Attribute fileName1 is String
Attribute fileName2 is String
Attribute endTime is String
Attribute burnIn is Integer

<gmrfBlockUpdateOperator>

Description:
This element returns a GMRF block-update operator for the joint distribution of the population sizes and precision parameter.
Rule:
Attribute scaleFactor is Double
Attribute weight is Double
Attribute autoOptimize is Boolean
Attribute stopValue is Double
Attribute maxIterations is Integer
Attribute oldSkyride is Boolean
GMRFSkyrideLikelihood element (exactly one)

<gmrfDensityComponent>

Description:
This element represents a single component (coalescent or field) of the GMRF Skyride.
Rule:
Attribute component is String
GMRFSkyrideLikelihood element (exactly one)

<gmrfFixedEffectsGibbsOperator>

Description:
This element returns a Gibbs operator for regression coefficients in a GMRF.
Rule:
Attribute weight is Double
Parameter element (exactly one)
GMRFSkyrideLikelihood element (exactly one)

<gmrfHeightsStatistic>

Description:
A statistic that returns the heights of each internal node in increasing order (or groups them by a group size parameter)
Rule:
Attribute name is String
GMRFSkyrideLikelihood element (exactly one)

<gmrfPopSizeStatistic>

Description:
The pop sizes at the given times
Rule:
Attribute from is Double
Attribute to is Double
Attribute number is Integer
Attribute time is Double;
GMRFSkyrideLikelihood element (exactly one)

<gmrfSkyrideLikelihood>

Description:
This element represents the likelihood of the tree given the population size vector.
Rule:
Element named populationSizes containing:
Parameter element (exactly one)
Element named precisionParameter containing:
Parameter element (exactly one)
Element named phiParameter containing:
Parameter element (exactly one)
Element named populationTree containing:
TreeModel elements (one or more)
Element named groupSizes containing:
Parameter element (exactly one)
Attribute rescaleByRootHeight is Boolean
Attribute randomizeTree is Boolean
Attribute timeAwareSmoothing is Boolean
Attribute oldSkyride is Boolean

<gmrfTestLikelihood>

Description:
This element represents the likelihood of the tree given the population size vector.
Rule:
Element named populationSizes containing:
Parameter element (exactly one)
Element named precisionParameter containing:
Parameter element (exactly one)
Element named lambdaParameter containing:
Parameter element (exactly one)

<gpSkytrackLikelihood>

Description:
This element represents the likelihood of the tree given the population size vector.
Rule:
Element named populationSizes containing:
Parameter element (exactly one)
Element named changePoints containing:
Parameter element (exactly one)
Element named precisionParameter containing:
Parameter element (exactly one)
Element named numGridPoints containing:
Parameter element (exactly one)
Element named lambdaBoundParameter containing:
Parameter element (exactly one)
Element named lambdaParameter containing:
Parameter element (exactly one)
Element named alphaParameter containing:
Parameter element (exactly one)
Element named betaParameter containing:
Parameter element (exactly one)
Element named populationTree containing:
TreeModel elements (one or more)
Attribute rescaleByRootHeight is Boolean
Attribute randomizeTree is Boolean

<greatCircleDiffusionModel>

Description:
Describes a bivariate diffusion process using great circle distances.
Rule:
Parameter element (exactly one)
Element named diffusionCoefficient containing:
Parameter element (exactly one)

<gtrCovarionModel>

Description:
A covarion substitution model of langauge evolution with binary data and a hidden rate state with two rates.
Rule:
Element named rateAC containing:
Parameter element (exactly one)
relative rate of A<->C substitution
Element named rateAG containing:
Parameter element (exactly one)
relative rate of A<->G substitution
Element named rateAT containing:
Parameter element (exactly one)
relative rate of A<->T substitution
Element named rateCG containing:
Parameter element (exactly one)
relative rate of C<->G substitution
Element named rateCT containing:
Parameter element (exactly one)
relative rate of C<->T substitution
Element named rateGT containing:
Parameter element (exactly one)
relative rate of G<->T substitution
Element named hiddenClassRates containing:
Parameter element (exactly one)
Element named switchingRates containing:
Parameter element (exactly one)
Element named frequencies containing:
FrequencyModel element (exactly one)

<gtrModel>

Description:
A general reversible model of nucleotide sequence substitution.
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named rateAC containing:
Variable element (exactly one)
Element named rateAG containing:
Variable element (exactly one)
Element named rateAT containing:
Variable element (exactly one)
Element named rateCG containing:
Variable element (exactly one)
Element named rateCT containing:
Variable element (exactly one)
Element named rateGT containing:
Variable element (exactly one)
Example:
<!-- A general time reversible model for DNA.                                          -->
<!-- This element must have parameters for exactly five of the six rates               -->
<!-- The sixth rate has an implied value of 1.0 and all other rates are relative to it -->
<!-- This example parameterizes the rate matrix relative to the A<->G transition       -->
<gtrModel id="gtr1">
	<frequencies> <frequencyModel idref="freqs"/> </frequencies>
	<rateAC> <parameter id="rateAC" value="1.0"/> </rateAC>
	<rateAT> <parameter id="rateAT" value="1.0"/> </rateAT>
	<rateCG> <parameter id="rateCG" value="1.0"/> </rateCG>
	<rateCT> <parameter id="rateCT" value="1.0"/> </rateCT>
	<rateGT> <parameter id="rateGT" value="1.0"/> </rateGT>
</gtrModel>

<harmonicMeanAnalysis>

Description:
Performs a trace analysis. Estimates the mean of the various statistics in the given log file.
Rule:
Attribute fileName is string
The traceName of a BEAST log file (can not include trees, which should be logged separately
Attribute burnIn is Integer
Attribute bootstrapLength is Integer
Attribute smoothedEstimate is Boolean
Element named likelihoodColumn containing:
Attribute name is string
The column name

<HiddenLinkageLikelihood>

Description:
A likelihood calculator for hidden linkage among metagenomic reads
Rule:
HiddenLinkageModel element (exactly one)
TreeModel element (exactly one)

<HiddenLinkageModel>

Description:
A model to describe missing information about linkage among several reads from a metagenome
Rule:
Attribute linkageGroupCount is string
The number of hidden lineages
MetagenomeData element (exactly one)

<hiddenNucleotides>

Description:
A nucleotide data type that allows hidden substitution classes
Rule:
Attribute classCount is Integer

<hierarchicalPartitionLikelihood>

Description:
null
Rule:
ARGModel element (exactly one)

<HKYModel>

Description:
This element represents an instance of the HKY85 (Hasegawa, Kishino & Yano, 1985) model of nucleotide evolution.
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named kappa containing:
Variable element (exactly one)

<hypermutantAlignment>

Description:
Converts an alignment so that 'A's at specific APOBEC targeted contexts are set to an A/G ambiguity code.
Rule:
Alignment element (exactly one)
Attribute type ∈ {all, both, hA3G, hA3F}
The type of APOBEC molecule being modelled

<hypermutantErrorModel>

Description:
This element returns a model that allows for APOBEC-type RNA editing.
Rule:
Attribute unlinkedRates is Boolean
HypermutantAlignment element (exactly one)
Element named hypermutationRate containing:
Parameter element (exactly one)
The hypermutation rate per target site per sequence
Element named hypermutationIndicators containing:
Parameter element (exactly one)
A binary indicator of whether the sequence is hypermutated

<ibdReporter>

Description:
This element represents a reporter for expected number of tips ibd.
Rule:
TreeModel element (exactly one)
BranchRateModel element (zero or one)
AbstractSubstitutionModel element (exactly one)
Parameter element (exactly one)

<ImportanceNarrowExchange>

Description:
This element represents a swap operator. This operator swaps a random subtree with its uncle.
Rule:
Attribute weight is Double
Attribute epsilon is Double
PatternList element (exactly one)
TreeModel element (exactly one)

<ImportancePruneAndRegraft>

Description:
This element represents a importance guided prune and regraft operator. This operator prunes a random subtree and regrafts it below a node chosen by an importance distribution.
Rule:
Attribute weight is Double
Attribute samples is Integer
TreeModel element (exactly one)

<ImportanceSubtreeSwap>

Description:
This element represents a importance guided subtree swap operator. This operator swaps a random subtree with a second subtree guided by an importance distribution.
Rule:
Attribute weight is Double
Attribute samples is Integer
TreeModel element (exactly one)

<individual>

Description:
Individual specimen from a species, possibly containing multiple genomes.
Rule:
Taxon elements (one or more)

<inhibitionLikelihood>

Description:
Provides the likelihood of a continuous trait evolving on a tree by a given diffusion model.
Rule:
TreeModel element (exactly one)
MatrixParameter element (exactly one)
Element named precision containing:
Parameter element (exactly one)

<integer>

Description:
returns an Integer. If a prompt attribute exists then the user is prompted for input, otherwise the character contents of the element are returned as an Integer.
Rule:
One of:
Attribute prompt is string
A message displayed to the user when entering a value for this integer
Integer element (exactly one)

<integerParameter>

Description:
An integer-valued parameter only for staircase bound.
Rule:
Attribute value is Integer;
Attribute dimension is Integer

<integratedMixtureModel>

Description:
This element represents a finite mixture of likelihood models.
Rule:
Attribute normalize is Boolean
Likelihood elements ( or more)
Parameter element (exactly one)

<intermediateExchange>

Description:
This element represents an intermediate exchange operator. This operator swaps two subtree random subtrees with a bias towards nearby subtrees.
Rule:
Attribute weight is Double
TreeModel element (exactly one)

<traitGibbsOperator>

Description:
This element returns a multivariate Gibbs operator on traits for possible all nodes.
Rule:
Attribute weight is Double
Attribute onlyInternalNodes is Boolean
Attribute onlyTipsWithPriors is Boolean
MultivariateDistributionLikelihood elements (zero or more)
Element named rootPrior containing:
GeoSpatialCollectionModel element (zero or one)

<invgammaPrior>

Description:
Calculates the prior probability of some data under a given inverse gamma distribution.
Rule:
Attribute shape is Double
Attribute scale is Double
Attribute offset is Double
Statistic elements (one or more)

<inverseGaussianDistributionModel>

Description:
Describes a inverse gaussian distribution with a given mean and shape (or standard deviation) that can be used in a distributionLikelihood element
Rule:
Attribute offset is Double
Element named mean containing:
One of:
Parameter element (exactly one)
Double element (exactly one)
Element named stdev containing:
One of:
Parameter element (exactly one)
Double element (exactly one)
Element named shape containing:
One of:
Parameter element (exactly one)
Double element (exactly one)

<invgammaPrior>

Description:
Calculates the prior probability of some data under a given inverse gamma distribution.
Rule:
Attribute shape is Double
Attribute scale is Double
Attribute offset is Double
Statistic elements (one or more)

<oneOnXPrior>

Description:
Calculates the (improper) prior proportional to Prod_i (1/x_i) for the given statistic x.
Rule:
One of:
Statistic elements (one or more)
Element named data containing:
Statistic elements (one or more)

<jointOperator>

Description:
This element represents an arbitrary list of operators; only the first is optimizable
Rule:
SimpleMCMCOperator elements (one or more)
Attribute weight is Double
Attribute targetAcceptance is Double

<kStateType>

Description:
Parser for k-state model.
Rule:
Attribute stateCount is Integer
Attribute startWith is Integer

<laplacePrior>

Description:
Calculates the prior probability of some data under a given laplace distribution.
Rule:
Attribute mean is Double
Attribute scale is Double
Statistic elements (one or more)

<latentLiabilityGibbsOperator>

Description:
This element returns a multivariate Gibbs operator on traits for tip nodes under a latent liability model.
Rule:
Attribute weight is Double
LatentLiabilityLikelihood element (exactly one)

<latentLiabilityLikelihood>

Description:
Provides the likelihood of a latent liability model on multivariate-binary trait data
Rule:
AbstractMultivariateTraitLikelihood element (exactly one)
The model for the latent random variables
Element named tipTrait containing:
CompoundParameter element (exactly one)
The parameter of tip locations from the tree
PatternList element (exactly one)
The binary tip data
TreeModel element (exactly one)
The tree model

<lewisMk>

Description:
A parser for Lewis' Mk model
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)
Attribute totalOrder is Boolean
Element named order containing:
Attribute state is String
Attribute adjacentTo is String

<compoundLikelihood>

Description:
A likelihood function which is simply the product of its component likelihood functions.
Rule:
Attribute threads is Integer
Likelihood elements (one or more)

<lineageCountStatistic>

Description:
Rule:
OldAbstractCoalescentLikelihood element (exactly one)

<LINEARBIASModel>

Description:
This element represents an instance of the stepwise mutation model of microsatellite evolution.
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named Submodel containing:
OnePhaseModel element (exactly one)
Microsatellite element (exactly one)
Element named BiasConstant containing:
Parameter element (exactly one)
Element named BiasLinear containing:
Parameter element (exactly one)
Attribute estimateSubmodelParameters is string
whether or not to esitmate the parameters of the submodel
Attribute logistics is Boolean
Attribute isSubmodel is Boolean

<LinkageConstraints>

Description:
Data representing metagenome reads that are linked by mate-pair, strobe, or other information
Rule:
LinkedGroup elements (one or more)

<linkageGroupSwap>

Description:
This element represents an operator that swaps taxa among two linkage groups.
Rule:
Attribute weight is Double
HiddenLinkageModel element (exactly one)

<LinkedGroup>

Description:
A group of metagenome reads linked with some probability
Rule:
Taxa element (exactly one)
Attribute probability is Double
the probability that the group of reads are linked to each other

<localClockModel>

Description:
This element returns a branch rate model that adds a delta to each terminal branch length.
Rule:
TreeModel element (exactly one)
Element named rate containing:
Parameter element (exactly one)
The molecular evolutionary rate parameter
Element named externalBranches containing:
Attribute relative is Boolean
Taxa element (exactly one)
A local clock that will be applied only to the external branches for these taxa
Parameter element (exactly one)
The rate parameter
Element named clade containing:
Attribute relative is Boolean
Attribute includeStem is Boolean
determines whether or not the stem branch above this clade is included in the siteModel (default false).
Attribute excludeClade is Boolean
determines whether to exclude actual branches of the clade from the siteModel (default false).
Taxa element (exactly one)
A set of taxa which defines a clade to apply a different site model to
Parameter element (exactly one)
The rate parameter
Element named backbone containing:
Attribute relative is Boolean
Taxa element (exactly one)
A local clock that will be applied only to the 'backbone' branches defined by these taxa
Parameter element (exactly one)
The rate parameter

<location>

Description:
Specifies a location with an optional longitude and latitude
Rule:
Attribute description is String
A description of this location
Attribute longitude is String
The longitude in degrees, minutes, seconds or decimal degrees
Attribute latitude is String
The latitude in degrees, minutes, seconds or decimal degrees

<log>

Description:
Logs one or more items at a given frequency to the screen or to a file
Rule:
Attribute logEvery is Integer
Attribute overwrite is Boolean
Attribute fileName is string
The name of the file to send log output to. If no file name is specified then log is sent to standard output
Attribute title is string
The title of the log
At least one of:
Columns elements (one or more)
Loggable elements (one or more)
Object elements (one or more)

<logAllTraits>

Description:
null
Rule:
TreeModel element (exactly one)
The tree which is to be logged

<logArg>

Description:
Logs an ARG to a file
Rule:
Attribute logEvery is Integer
Attribute format ∈ {dotFormat, extendedNewick, compressedString, fullString, strippedNewick, distinctTrees}
The type logger's output type
Attribute fileName is string
The name of the file to send log output to. If no file name is specified then log is sent to standard output
Attribute title is string
The title of the log
ARGModel element (exactly one)
The ARG which is to be logged
Example:
<!-- The logArg element takes an argModel to be logged -->
<logArg logEvery="100" fileName="log.args">
	<argModel idref="treeModel1"/>
</logArg>

<logArgTree>

Description:
Logs a tree to a file
Rule:
Attribute logEvery is Integer
Attribute partition is Integer
Attribute fileName is string
The name of the file to send log output to. If no file name is specified then log is sent to standard output
Attribute title is string
The title of the log
Attribute nexusFormat is Boolean
Whether to use the NEXUS format for the tree log
Attribute branchLengths ∈ {time, substitutions}
What units should the branch lengths be in
ARGModel element (exactly one)
The ARG which is to be logged
BranchRateModel element (zero or one)
ColourSamplerModel element (zero or one)
Likelihood element (zero or one)
Example:
<!-- The logArgTree element takes an argTreeModel to be logged -->
<logArgTree logEvery="100" fileName="log.trees" nexusFormat="true">
	<treeModel idref="treeModel1"/>
</logArgTree>

<logarithmStatistic>

Description:
This element returns a statistic that is the element-wise natural logarithm of the child statistic.
Rule:
Attribute base is Double
An optional base for the logarithm (default is the natural logarithm, base e)
Statistic element (exactly one)

<logarithmStatistic>

Description:
This element returns a statistic that is the element-wise natural logarithm of the child statistic.
Rule:
Attribute base is Double
An optional base for the logarithm (default is the natural logarithm, base e)
Statistic element (exactly one)

<logFileTrace>

Description:
reconstruct population graph from variable dimension run.
Rule:
Attribute fileName is String
trace log.
Attribute burnIn is Integer
The number of states (not sampled states, but actual states) that are discarded from the beginning of the trace before doing the analysis

<loggableStatistic>

Description:
Allows you to choose specific dimensions of a given statistic
Rule:
Loggable element (exactly one)

<logHiddenLinkage>

Description:
Logs a linkage groups for metagenomic reads to a file
Rule:
Attribute logEvery is Integer
Attribute fileName is string
The name of the file to send log output to. If no file name is specified then log is sent to standard output
HiddenLinkageModel element (exactly one)
The linkage model which is to be logged

<logHiddenLinkageTree>

Description:
Logs a tree with hidden linkage among metagenomic reads to a file
Rule:
Attribute logEvery is Integer
Attribute overwrite is Boolean
Attribute fileName is string
The name of the file to send log output to. If no file name is specified then log is sent to standard output
Attribute title is string
The title of the log
Attribute nexusFormat is Boolean
Whether to use the NEXUS format for the tree log
Attribute sortTranslationTable is Boolean
Whether the translation table is sorted.
Attribute branchLengths ∈ {time, substitutions}
What units should the branch lengths be in
Attribute traitFilter is String
Attribute mapNamesToNumbers is Boolean
Attribute dp is Integer
Tree element (exactly one)
The tree which is to be logged
Element named trait containing:
Attribute name is String
The name of the trait
Attribute tag is String
The label of the trait to be used in the tree
TreeAttributeProvider element (exactly one)
The trait provider
Likelihood element (zero or one)
Loggable elements (zero or more)
TreeAttributeProvider elements (zero or more)
TreeTraitProvider elements (zero or more)
TreeLogger$LogUpon element (zero or one)
HiddenLinkageModel element (exactly one)
Example:
<!-- The logHiddenLinkageTree element takes a treeModel to be logged -->
<logHiddenLinkageTree logEvery="100" fileName="log.trees" nexusFormat="true">
	<treeModel idref="treeModel1"/>
</logHiddenLinkageTree>

<logisticGrowth>

Description:
Logistic growth demographic model.
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named populationSize containing:
Parameter element (exactly one)
This parameter represents the carrying capacity (maximum population size). If the shape is very large then the current day population size will be very close to the carrying capacity.
One of:
Element named growthRate containing:
Parameter element (exactly one)
This parameter determines the rate of growth during the exponential phase. See exponentialGrowth for details.
Element named doublingTime containing:
Parameter element (exactly one)
This parameter determines the doubling time at peak growth rate.
Element named t50 containing:
Parameter element (exactly one)
This parameter represents the time in the past when the population had half of the carrying capacity (population size). It is therefore a positive number with the same units as divergence times. A scale operator is recommended with a starting value near zero. A lower bound of zero should be employed and an upper bound is required!

<logML>

Description:
Logs one or more items every time the given likelihood improves
Rule:
Attribute logEvery is Integer
Element named ml containing:
Likelihood element (exactly one)
At least one of:
Columns elements (one or more)
Loggable elements (one or more)

<logNormalDistributionModel>

Description:
Describes a normal distribution with a given mean and standard deviation that can be used in a distributionLikelihood element
Rule:
Attribute meanInRealSpace is Boolean
Attribute stdevInRealSpace is Boolean
Attribute offset is Double
Element named mean containing:
One of:
Parameter element (exactly one)
Double element (exactly one)
One of:
Element named stdev containing:
One of:
Parameter element (exactly one)
Double element (exactly one)
Element named precision containing:
One of:
Parameter element (exactly one)
Double element (exactly one)

<logNormalPrior>

Description:
Calculates the prior probability of some data under a given lognormal distribution.
Rule:
Attribute mean is Double
Attribute stdev is Double
Attribute offset is Double
Attribute meanInRealSpace is Boolean
Statistic elements (one or more)

<logRandomWalkOperator>

Description:
This element returns a scale operator on a given parameter.
Rule:
Attribute window is Double
Attribute weight is Double
Attribute autoOptimize is Boolean
Attribute scaleAll is Boolean
Attribute scaleAllIndependently is Boolean
Parameter element (exactly one)

<logTree>

Description:
Logs a tree to a file
Rule:
Attribute logEvery is Integer
Attribute overwrite is Boolean
Attribute fileName is string
The name of the file to send log output to. If no file name is specified then log is sent to standard output
Attribute title is string
The title of the log
Attribute nexusFormat is Boolean
Whether to use the NEXUS format for the tree log
Attribute sortTranslationTable is Boolean
Whether the translation table is sorted.
Attribute branchLengths ∈ {time, substitutions}
What units should the branch lengths be in
Attribute traitFilter is String
Attribute mapNamesToNumbers is Boolean
Attribute dp is Integer
Tree element (exactly one)
The tree which is to be logged
Element named trait containing:
Attribute name is String
The name of the trait
Attribute tag is String
The label of the trait to be used in the tree
TreeAttributeProvider element (exactly one)
The trait provider
Likelihood element (zero or one)
Loggable elements (zero or more)
TreeAttributeProvider elements (zero or more)
TreeTraitProvider elements (zero or more)
TreeLogger$LogUpon element (zero or one)
Example:
<!-- The logTree element takes a treeModel to be logged -->
<logTree logEvery="100" fileName="log.trees" nexusFormat="true">
	<treeModel idref="treeModel1"/>
</logTree>

<marginalLikelihoodAnalysis>

Description:
Performs a trace analysis. Estimates the mean of the various statistics in the given log file.
Rule:
Attribute fileName is string
The traceName of a BEAST log file (can not include trees, which should be logged separately
Attribute burnIn is Integer
Element named likelihoodColumn containing:
Attribute name is string
The column name

<marginalLikelihoodEstimator>

Description:
This element returns an MCMC chain and runs the chain as a side effect.
Rule:
Attribute chainLength is Integer
Attribute pathSteps is Integer
Attribute burnin is Integer
Attribute prerun is Integer
Attribute linear is Boolean
Attribute lacing is Boolean
Attribute spawn is Boolean
Attribute pathScheme is String
Attribute alpha is Double
Attribute beta is Double
Element named samplers containing:
MCMC elements (one or more)
PathLikelihood element (exactly one)
MCLogger element (exactly one)

<markovJumpsTreeLikelihood>

Description:
This element represents the likelihood of a patternlist on a tree given the site model.

<maskedParameter>

Description:
A masked parameter.
Rule:
Parameter element (exactly one)
Element named mask containing:
Parameter element (exactly one)
Attribute complement is Boolean
Attribute from is Integer
Attribute to is Integer
Attribute every is Integer

<matrixInverse>

Description:
This element returns a statistic that is the matrix inverse of the child statistic.
Rule:
MatrixParameter element (exactly one)

<matrixParameter>

Description:
A matrix parameter constructed from its component parameters.
Rule:
Parameter elements (zero or more)
Attribute rows is Integer
Attribute columns is Integer

<mcmc>

Description:
This element returns an MCMC chain and runs the chain as a side effect.
Rule:
Attribute chainLength is Long
Attribute autoOptimize is Boolean
Attribute autoOptimizeDelay is Integer
Attribute preBurnin is Integer
Attribute temperature is Double
Attribute fullEvaluation is Integer
Attribute minOpsFullEvaluations is Integer
Attribute spawn is Boolean
Attribute name is String
Attribute operatorAnalysis is String
OperatorSchedule element (exactly one)
Likelihood element (exactly one)
Logger elements (one or more)

<meanStatistic>

Description:
This element returns a statistic that is the mean of the child statistics.
Rule:
Statistic elements (one or more)

<mergePatterns>

Description:
A weighted list of the unique site patterns (unique columns) in an alignment.
Rule:
PatternList elements (one or more)

<MetagenomeData>

Description:
Data representing metagenome reads aligned to reference sequences and a reference tree
Rule:
One of:
Taxa element (exactly one)
Tree element (exactly one)
Alignment element (exactly one)
LinkageConstraints element (zero or one)
Attribute fixedReferenceTree is Boolean
Whether the reference tree should be of fixed topology

<metaPopulationModel>

Description:
A model that represents a subdivided population.
Rule:
DemographicModel elements (one to 999)
Parameter element (zero or one)

<microsatellite>

Description:
This element represents a microsatellite data type.
Rule:
All of:
Attribute id is String
Attribute min is Integer
Attribute max is Integer
Attribute unitLength is Integer
Example:
<microsatellite min="0" max="20" unitLength="2"/>

<microsatellitePattern>

Description:
This element represents a microsatellite pattern.
Rule:
Taxa element (exactly one)
Microsatellite element (exactly one)
Element named microsatSeq containing:
String element (exactly one)
A string of numbers representing the microsatellite lengths for a locus
Attribute id is string
the name of the locus
Attribute printDetails is Boolean
Attribute printMsatPatContent is Boolean

<microsatelliteSamplerTreeLikelihood>

Description:
this parser returns an object of the TreeMicrosatelliteSamplerLikelihood class
Rule:
MicrosatelliteSamplerTreeModel element (exactly one)
MicrosatelliteModel element (exactly one)
Element named mutationRate containing:
Parameter element (exactly one)
BranchRateModel element (zero or one)

<microsatelliteSamplerTreeModel>

Description:
This parser returns a TreeMicrosatelliteSamplerModel Object
Rule:
Attribute provideInternalNodeValues is Boolean
Element named tree containing:
TreeModel element (exactly one)
Element named internalValues containing:
Parameter element (exactly one)
Element named externalValues containing:
Patterns element (exactly one)

<microsatelliteSimulator>

Description:
This parser facilliates simulation of microsatellites given a tree and infinitesimal rate model
Rule:
Microsatellite element (exactly one)
Taxa element (exactly one)
Tree element (exactly one)
MicrosatelliteModel element (exactly one)
BranchRateModel element (zero or one)

<microsatUpDownOperator>

Description:
This element represents an operator that scales two parameters in different directions. Each operation involves selecting a scale uniformly at random between scaleFactor and 1/scaleFactor. The up parameter is multipled by this scale and the down parameter is divided by this scale.
Rule:
Attribute scaleFactor is Double
Attribute weight is Double
Attribute autoOptimize is Boolean
Element named up containing:
Parameter element (zero or one)
Element named down containing:
Parameter element (zero or one)

<mixedDistributionLikelihood>

Description:
Calculates the likelihood of some data given some mix of parametric distributions.
Rule:
Element named distribution0 containing:
ParametricDistributionModel element (exactly one)
Element named distribution1 containing:
ParametricDistributionModel element (exactly one)
Element named data containing:
Statistic element (exactly one)
Element named indicators containing:
Statistic element (exactly one)

<mixtureCartogramDiffusionModel>

Description:
Describes a bivariate diffusion process using cartogram distances.
Rule:
Parameter element (exactly one)
Element named mixture containing:
Parameter element (exactly one)
Element named boundingBox containing:
Attribute minX is Double
Attribute maxX is Double
Attribute minY is Double
Attribute maxY is Double

<mixtureModel>

Description:
This element represents a finite mixture of likelihood models.
Rule:
Attribute normalize is Boolean
Likelihood elements ( or more)
Parameter element (exactly one)

<mixtureModelBranchRates>

Description:
This element returns a random discretized relaxed clock model.The branch rates are drawn from a continuous parametric distribution.
Rule:
Attribute singleRootRate is Boolean
Whether only a single rate should be used for the two children branches of the root
Attribute normalize is Boolean
Whether the mean rate has to be normalized to a particular value
Attribute normalizeBranchRateTo is Double
The mean rate to normalize to, if normalizing
Attribute useQuantilesForRates is Boolean
Whether or not to use quantiles to represent rates. If false then rates are not drawn specifically from any of the distributions
TreeModel element (exactly one)
Element named distribution containing:
ParametricDistributionModel element (exactly one)
The distribution model for rates among branches
Element named distributionIndex containing:
Parameter element (exactly one)
Operator that switches between the distributions of the branch rate distribution model
Element named rateCategoryQuantiles containing:
Parameter element (exactly one)
The quantiles for

<mkSubstitutionModel>

Description:
An Mk model of substitution. This model can also accomodate arbitrary orderings of changes.
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)

<modelAveragingIndexSpeciationLikelihood>

Description:
Model Averaging Speciation Likelihood.
Rule:
Element named modelIndex containing:
Variable element (exactly one)
Element named maxIndex containing:
Parameter element (exactly one)

<modelAveragingSpeciationLikelihood>

Description:
Model Averaging Speciation Likelihood.
Rule:
Element named sM containing:
MaskableSpeciationModel elements (one or more)
Element named sT containing:
Tree elements (one or more)
Element named modelIndex containing:
Variable element (exactly one)
Element named maxIndex containing:
Parameter element (exactly one)

<modelSpecificPseudoPrior>

Description:
Calculates the likelihood of some data given some parametric or empirical distribution.

<monophylyStatistic>

Description:
A statistic that returns true if a given set of taxa are monophyletic for a given tree
Rule:
Attribute name is string
A name for this statistic for the purpose of logging
Tree element (exactly one)
Element named mrca containing:
One of:
Taxon elements (one or more)
Taxa element (exactly one)
Element named ignore containing:
One of:
Taxon elements (one or more)
Taxa element (exactly one)
An optional list of taxa to ignore from the test of monophyly

<monotonicStatistic>

Description:
Rule:
Attribute order is String
Attribute strictlyMonotic is Boolean
Statistic elements (one or more)

<moveLegs>

Description:
Operator which changes the way a tetraploid subtree joins the diploid tree.
Rule:
Attribute weight is Double
AlloppSpeciesBindings element (exactly one)
AlloppSpeciesNetworkModel element (exactly one)

<moveLinkageGroup>

Description:
Operator to reassign metagenomic reads from one linkage group to another
Rule:
Attribute weight is string
Weight of the move
HiddenLinkageModel element (exactly one)

<mrcaTraitStatistic>

Description:
A statistic that has as its value the height of the most recent common ancestor of a set of taxa in a given tree
Rule:
TreeModel element (exactly one)
Attribute name is string
A name for this statistic primarily for the purposes of logging
Attribute trait is string
The name of the trait (can be rate)
Attribute rate is Boolean
Element named mrca containing:
Taxa element (exactly one)

<msatBMA>

Description:
This element represents an instance of the Microsatellite Averaging Model of microsatellite evolution.
Rule:
Microsatellite element (exactly one)
Attribute logit is Boolean
Element named models containing:
Element named model containing:
Attribute binary is String
Attribute code is String
Element named rateProps containing:
Element named rateProp containing:
Attribute inModels is Integer;
Parameter element (exactly one)
Element named rateQuads containing:
Element named rateQuad containing:
Attribute inModels is Integer;
Parameter element (exactly one)
Element named biasConsts containing:
Element named biasConst containing:
Attribute inModels is Integer;
Parameter element (exactly one)
Element named biasLins containing:
Element named biasLin containing:
Attribute inModels is Integer;
Parameter element (exactly one)
Element named geos containing:
Element named geo containing:
Attribute inModels is Integer;
Parameter element (exactly one)
Element named phaseProbs containing:
Element named phaseProb containing:
Attribute inModels is Integer;
Parameter element (exactly one)
Element named modelChoose containing:
Parameter element (exactly one)
Element named modelIndicator containing:
Parameter element (exactly one)

<MsatFullAncestryImportanceSamplingOperator>

Description:
This element represents an operator that samples the full ancestry given a microsatellite pattern and a tree
Rule:
Attribute weight is Double
Parameter element (exactly one)
MicrosatelliteSamplerTreeModel element (exactly one)
MicrosatelliteModel element (exactly one)
BranchRateModel element (exactly one)

<msatModelSelectOperator>

Description:
This element returns a microsatellite averaging operator on a given parameter.
Rule:
Attribute weight is Double
Element named modelChoose containing:
Parameter element (exactly one)
Element named modelIndicators containing:
Parameter elements (one or more)

<msatModelSwitchOperator>

Description:
This element returns a microsatellite averaging operator on a given parameter.
Rule:
Attribute weight is Double
Element named modelChoose containing:
Parameter element (exactly one)
Element named dependencies containing:
Parameter element (exactly one)
Element named variableIndices containing:
Parameter element (exactly one)

<msatPatternStatistic>

Description:
Returns MsatPatternStatistic object
Rule:
Patterns element (exactly one)
Attribute mode is String

<MsatSingleAncestralStateGibbsOperator>

Description:
This element represents an operator that samples the state of a single ancestor given a microsatellite pattern and a tree
Rule:
Attribute weight is Double
Parameter element (exactly one)
MicrosatelliteSamplerTreeModel element (exactly one)
MicrosatelliteModel element (exactly one)
BranchRateModel element (exactly one)

<mulMSCoalescent>

Description:
Compute coalecent log-liklihood of a set of gene trees embedded inside one species tree.
Rule:
MulSpeciesBindings element (exactly one)
MulSpeciesTreeModel element (exactly one)

<mulSpecies>

Description:
Binds taxa to gene trees with information about possibly allopolyploid species.
Rule:
AlloppSpeciesBindings$ApSpInfo elements ( or more)
Element named geneTrees containing:
TreeModel elements (zero or more)
Element named gtree containing:
Attribute popfactor is Double
TreeModel element (exactly one)

<mulSpeciesTree>

Description:
Multiply-labelled species tree which includes demographic function per branch.
Rule:
Attribute constantRoot is Boolean
Attribute constantPopulation is Boolean
MulSpeciesBindings element (exactly one)
Tree element (zero or one)
Element named sppSplitPopulations containing:
Attribute value is Double
Parameter element (exactly one)

<mulSpeciesTreePrior>

Description:
Prior for a multiply-labelled species tree for allopolyploids.
Rule:
Element named model containing:
SpeciationModel element (exactly one)
Element named mulTree containing:
MulSpeciesTreeModel element (exactly one)

<multidimensionalScalingLikelihood>

Description:
Provides the likelihood of pairwise distance given vectors of coordinatesfor points according to the multidimensional scaling scheme of XXX & Rafferty (xxxx).
Rule:
Attribute fileName is String
The name of the file containing the assay table
Attribute mdsDimension is Integer
The dimension of the space for MDS
Element named locations containing:
MatrixParameter element (exactly one)
Element named mdsPrecision containing:
Parameter element (exactly one)

<multiLociDistance>

Description:
Constructs a distance matrix from a pattern list or alignment
Rule:
DistanceMatrix elements (one or more)

<multivariateDiffusionModel>

Description:
Describes a multivariate normal diffusion process.
Rule:
Element named precisionMatrix containing:
MatrixParameter element (exactly one)

<multivariateGammaPrior>

Description:
Calculates the likelihood of some data under a given multivariate-gamma distribution.
Rule:
One of:
Element named shapeParameter containing:
Parameter element (exactly one)
Element named meanParameter containing:
Parameter element (exactly one)
One of:
Element named scaleParameter containing:
Parameter element (exactly one)
Element named coefficientOfVariation containing:
Parameter element (exactly one)
Element named data containing:
Parameter elements (one or more)

<multivariateInverseWishartPrior>

Description:
Calculates the likelihood of some data under an Inverse-Wishart distribution.
Rule:
Attribute df is Double
Element named scaleMatrix containing:
MatrixParameter element (exactly one)

<multivariateNormalPrior>

Description:
Calculates the likelihood of some data under a given multivariate-normal distribution.
Rule:
Element named meanParameter containing:
Parameter element (exactly one)
Element named precisionParameter containing:
MatrixParameter element (exactly one)
Element named data containing:
Parameter elements (one or more)

<multivariateOUModel>

Description:
Describes a multivariate OU process
Rule:
SubstitutionModel element (exactly one)
MatrixParameter element (exactly one)
Element named data containing:
Parameter element (exactly one)
Element named times containing:
Parameter element (exactly one)
Element named design containing:
Parameter element (exactly one)
Element named independentVariables containing:
MatrixParameter element (exactly one)

<multivariateTDiffusionModel>

Description:
Describes a multivariate t-distribution diffusion process.
Rule:
Element named precisionParameter containing:
Parameter element (exactly one)
Element named dfParameter containing:
Parameter element (exactly one)

<multivariateTraitLikelihood>

Description:
Provides the likelihood of a continuous trait evolving on a tree by a given diffusion model.
Rule:
Attribute traitName is string
The name of the trait for which a likelihood should be calculated
Element named traitParameter containing:
Parameter element (exactly one)
Element named delta containing:
Parameter element (exactly one)
Attribute integrateInternalTraits is Boolean
Element named conjugateRootPrior containing:
Element named meanParameter containing:
Parameter element (exactly one)
Element named priorSampleSize containing:
Parameter element (exactly one)
Element named ascertainedTaxon containing:
Taxon element (exactly one)
MultivariateDiffusionModel element (exactly one)
TreeModel element (exactly one)
BranchRateModel element (zero or one)
Attribute cut is Double;
Attribute reportAsMultivariate is Boolean
Attribute useTreeLength is Boolean
Attribute scaleByTime is Boolean
Attribute reciprocalRates is Boolean
Attribute cacheBranches is Boolean
Attribute randomSample is Integer
Attribute ignorePhylogeny is Boolean
Attribute exchangeableTips is Boolean
Parameter element (zero or one)
Element named randomize containing:
Attribute lower is Double
Attribute upper is Double
Parameter element (exactly one)
Element named jitter containing:
Attribute window is Double;
Attribute duplicatesOnly is Boolean
Parameter element (exactly one)
Element named check containing:
Parameter element (exactly one)

<multivariateWishartPrior>

Description:
Calculates the likelihood of some data under a Wishart distribution.
Rule:
Attribute nonInformative is Boolean
Attribute df is Double
Element named scaleMatrix containing:
MatrixParameter element (exactly one)
Element named data containing:
MatrixParameter elements (one or more)

<mulTreeNodeReHeight>

Description:
Specialized Species tree operator, transform tree without breaking embedding of gene trees.
Rule:
Attribute weight is Double
MulSpeciesBindings element (exactly one)
MulSpeciesTreeModel element (exactly one)

<mulTreeSequenceReassignment>

Description:
Operator which reassigns sequences within an allopolyploid species.
Rule:
Attribute weight is Double
MulSpeciesBindings element (exactly one)
MulSpeciesTreeModel element (exactly one)

<MutationDeathModel>

Description:
This element represents an instance of the MutationDeath model of CTMC evolution with deletions.
Rule:
AbstractSubstitutionModel element (zero or one)
Parameter element (exactly one)
MutationDeathType element (exactly one)
Element named mutationRate containing:
Parameter element (exactly one)

<mvnOperator>

Description:
This element returns a multivariate normal random walk operator on a given parameter.
Rule:
Attribute scaleFactor is Double
Attribute weight is Double
Attribute autoOptimize is Boolean
Attribute formXtXInverse is Boolean
Parameter element (exactly one)
Element named varMatrix containing:
MatrixParameter element (exactly one)

<mvouOperator>

Description:
This element returns junk.
Rule:
Attribute mixingFactor is Double
Attribute priorDf is Integer
Attribute weight is Double
Attribute autoOptimize is Boolean
MatrixParameter element (exactly one)

<mvPolyaLikelihood>

Description:
A matrix parameter constructed from its component parameters.
Rule:
Element named data containing:
MatrixParameter element (exactly one)
Element named dispersion containing:
Parameter element (exactly one)
Element named frequencies containing:
Parameter element (exactly one)

<narrowExchange>

Description:
This element represents a narrow exchange operator. This operator swaps a random subtree with its uncle.
Rule:
Attribute weight is Double
TreeModel element (exactly one)

<NearestNeighborInterchange>

Description:
This element represents a NNI operator. This operator swaps a random subtree with its uncle.
Rule:
Attribute weight is Double
TreeModel element (exactly one)

<negativeStatistic>

Description:
This element returns a statistic that is the element-wise negation of the child statistic.
Rule:
Statistic element (exactly one)

<negativeStatistic>

Description:
This element returns a statistic that is the element-wise negation of the child statistic.
Rule:
Statistic element (exactly one)

<negativeStatistic>

Description:
This element returns a statistic that is the element-wise negation of the child statistic.
Rule:
Statistic element (exactly one)

<neighborJoiningTree>

Description:
This element returns a neighbour-joining tree generated from the given distances.
Rule:
DistanceMatrix element (exactly one)

<networkNodeReHeight>

Description:
Operator for allopolyploid species network: transforms network without breaking embedding of gene trees.
Rule:
Attribute weight is Double
AlloppSpeciesBindings element (exactly one)
AlloppSpeciesNetworkModel element (exactly one)

<newARGEvent>

Description:
An operator that slides a subarg.
Rule:
Attribute weight is Integer
Attribute size is Double
Attribute gaussian is Boolean
Attribute swapRates is Boolean
Attribute swapTraits is Boolean
Attribute autoOptimize is Boolean
ARGModel element (exactly one)

<newick>

Description:
Constructs a tree from a NEWICK format tree description
Rule:
Attribute usingDates is Boolean
Attribute rescaleHeight is Double
Attempt to rescale the tree to the given root height
Attribute rescaleLength is Double
Attempt to rescale the tree to the given total length
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
The branch length units of this tree
String element (exactly one)
The NEWICK format tree. Tip labels are taken to be Taxon IDs
Example:
<newick units="years"> ((A:1.0, B:1.0):1.0,(C:2.0, D:2.0):1.0); </newick>

<node>

Description:
This element represents a node in a tree.
Rule:
Attribute height is Double
the age of the node
Attribute rate is Double
the relative rate of evolution at this node - default is 1.0
One of:
Taxon element (exactly one)
The taxon of this leaf node
SimpleNode elements (exactly 2)
The children of this internal node

<nodeHeightsStatistic>

Description:
A statistic that returns the heights of each internal node in increasing order (or groups them by a group size parameter)
Rule:
Attribute name is String
TreeModel element (exactly one)
Parameter element (zero or one)

<nodePosteriorLikelihood>

Description:
This element represents the likelihood of a patternlist on a tree given the site model.
Rule:
Attribute useAmbiguities is Boolean
Attribute allowMissingTaxa is Boolean
PatternList element (exactly one)
TreeModel element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (zero or one)
SubstitutionModel element (exactly one)

<nodeReHeight>

Description:
Specialized Species tree operator, transform tree without breaking embedding of gene trees.
Rule:
Attribute weight is Double
SpeciesBindings element (exactly one)
SpeciesTreeModel element (exactly one)

<normalDistributionModel>

Description:
Describes a normal distribution with a given mean and standard deviation that can be used in a distributionLikelihood element
Rule:
Element named mean containing:
One of:
Parameter element (exactly one)
Double element (exactly one)
One of:
Element named stdev containing:
One of:
Parameter element (exactly one)
Double element (exactly one)
Element named precision containing:
One of:
Parameter element (exactly one)
Double element (exactly one)

<normalGammaPrecisionGibbsOperator>

Description:
This element returns a operator on the precision parameter of a normal model with gamma prior.
Rule:
Attribute weight is Double
Element named likelihood containing:
DistributionLikelihood element (exactly one)
Element named prior containing:
DistributionLikelihood element (exactly one)

<normalNormalMeanGibbsOperator>

Description:
This element returns a operator on the mean parameter of a normal model with normal prior.
Rule:
Attribute weight is Double
Element named likelihood containing:
DistributionLikelihood element (exactly one)
Element named prior containing:
DistributionLikelihood element (exactly one)

<normalPrior>

Description:
Calculates the prior probability of some data under a given normal distribution.
Rule:
Attribute mean is Double
Attribute stdev is Double
Statistic elements (one or more)

<notStatistic>

Description:
This element returns a statistic that is the element-wise inverse of the child statistic.
Rule:
Statistic element (exactly one)

<notStatistic>

Description:
This element returns a statistic that is the element-wise inverse of the child statistic.
Rule:
Statistic element (exactly one)

<ntdBMA>

Description:
A model that allows model averaging over nucleotide substitution models.
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named kappa containing:
Variable element (exactly one)
Element named ac containing:
Variable element (exactly one)
Element named at containing:
Variable element (exactly one)
Element named gc containing:
Variable element (exactly one)
Element named gt containing:
Variable element (exactly one)
Element named modelChoose containing:
Variable element (exactly one)

<olddNdSPerSiteAnalysis>

Description:
Performs a trace dN dS analysis.
Rule:
Attribute fileName is string
The traceName of a BEAST log file (can not include trees, which should be logged separately

<oneOnXPrior>

Description:
Calculates the (improper) prior proportional to Prod_i (1/x_i) for the given statistic x.
Rule:
One of:
Statistic elements (one or more)
Element named data containing:
Statistic elements (one or more)

<onePGammaDistributionModel>

Description:
A model of a one parameter gamma distribution.
Rule:
One of:
Element named shape containing:
Double element (exactly one)
Element named shape containing:
Parameter element (exactly one)

<operators>

Description:
A simple operator scheduler
Rule:
Attribute sequential is Boolean
MCMCOperator elements (one or more)
Attribute optimizationSchedule is String

<optimizer>

Description:
This element returns a maximum likelihood heuristic optimizer and runs the optimization as a side effect.
Rule:
Attribute chainLength is Integer
OperatorSchedule element (exactly one)
Likelihood element (exactly one)
Logger elements (one or more)

<Ornstein-Uhlenbeck>

Description:
Rule:
Attribute logUnits is Boolean
Attribute normalize is Boolean
One of:
Element named mean containing:
Double element (exactly one)
Element named mean containing:
Parameter element (exactly one)
One of:
Element named sigma containing:
Double element (exactly one)
Element named sigma containing:
Parameter element (exactly one)
One of:
Element named lambda containing:
Double element (exactly one)
Element named lambda containing:
Parameter element (exactly one)
VariableDemographicModel element (zero or one)
Element named data containing:
Statistic element (exactly one)
Element named times containing:
Statistic element (exactly one)

<ovariableSkyLineLikelihood>

Description:
This element represents the likelihood of the tree given the population size vector.
Rule:
Attribute type is Boolean
Element named populationSizes containing:
Parameter element (exactly one)
Element named indicators containing:
Parameter element (exactly one)
Element named populationTree containing:
TreeModel element (exactly one)
Attribute logUnits is Boolean

<parameter>

Description:
A real-valued parameter of one or more dimensions.
Rule:
Attribute value is Double;
Attribute dimension is Integer
Attribute upper is Double;
Attribute lower is Double;
Element named randomize containing:
Distribution element (exactly one)

<parsimonyStateStatistic>

Description:
A statistic that has as its value the parsimony state reconstruction of a binary state defined by a set of taxa at a given MRCA of a tree
Rule:
Attribute name is string
A name for this statistic for the purposes of logging
TreeModel element (exactly one)
Element named state containing:
Taxa element (exactly one)
Element named mrca containing:
Taxa element (exactly one)

<parsimonyStatistic>

Description:
A statistic that has as its value the parsimony tree length of a set of a binary state defined by a set of taxa for a given tree
Rule:
Attribute name is string
A name for this statistic primarily for the purposes of logging
TreeModel element (exactly one)
Element named state containing:
Taxa element (exactly one)

<partitionStatistic>

Description:
null

<passageBranchRateModel>

Description:
This element returns a branch rate model that has a different rate for external branches than internal.
Rule:
Element named externalRate containing:
Parameter element (exactly one)
The molecular evolutionary rate parameter for external branches
Element named internalRate containing:
Parameter element (exactly one)
The molecular evolutionary rate parameter for internal branches

<pathLikelihood>

Description:
A likelihood function used for estimating marginal likelihoods and Bayes factors using path sampling.
Rule:
Element named source containing:
Likelihood element (exactly one)
Element named destination containing:
Likelihood element (exactly one)
Element named sourcePseudoPrior containing:
Likelihood element (exactly one)
Element named destinationPseudoPrior containing:
Likelihood element (exactly one)

<pathSamplingAnalysis>

Description:
Performs a trace analysis.
Rule:
Attribute fileName is string
The traceName of a BEAST log file (can not include trees, which should be logged separately
Element named thetaColumn containing:
Attribute name is string
The column name
Element named likelihoodColumn containing:
Attribute name is string
The column name

<patterns>

Description:
A weighted list of the unique site patterns (unique columns) in an alignment.
Rule:
Attribute from is Integer
The site position to start at, default is 1 (the first position)
Attribute to is Integer
The site position to finish at, must be greater than from, default is length of given alignment
Attribute every is Integer
Determines how many sites are selected. A value of 3 will select every third site starting from from, default is 1 (every site)
Element named taxonList containing:
TaxonList element (exactly one)
Alignment element (exactly one)
Attribute strip is Boolean
Strip out completely ambiguous sites
Attribute unique is Boolean
Return a weight list of unique patterns

<patternSubSet>

Description:
A weighted list of the unique site patterns (unique columns) in an alignment.
Rule:
Attribute subSet is Integer
Which subset of patterns to use (out of subSetCount)
Attribute subSetCount is Integer
The number of subsets
SiteList element (exactly one)

<pcaCodonModel>

Description:
This element represents the PCA model of codon evolution.
Rule:
Attribute geneticCode ∈ {universal, vertebrateMitochondrial, yeast, moldProtozoanMitochondrial, invertebrateMitochondrial, ciliate, echinodermMitochondrial, euplotidNuclear, bacterial, alternativeYeast, ascidianMitochondrial, flatwormMitochondrial, blepharismaNuclear, noStops}
The genetic code to use
Attribute pcaType ∈ {null}
The PCA type to use
Attribute pcaDataDir is string
The directory with the PCA data files
Element named pcaDimension containing:
Parameter element (exactly one)
FrequencyModel element (zero or one)

<piecewisePopulation>

Description:
This element represents a piecewise population model
Rule:
One of:
Element named epochSizes containing:
Parameter element (exactly one)
All of:
Element named populationSize containing:
Parameter element (exactly one)
Element named growthRates containing:
Parameter element (exactly one)
Element named epochWidths containing:
Attribute widths is Double;
Attribute linear is Boolean

<plinkImport>

Description:
Provides the likelihood of pairwise distance given vectors of coordinatesfor points according to the multidimensional scaling scheme of XXX & Rafferty (xxxx).
Rule:
Attribute fileName is String
The name of the file containing the plink table
At least one of:
Taxa elements (one or more)
Taxon elements (one or more)
Attribute traitName is String

<poissonPartitionLikelihood>

Description:
null
Rule:
Attribute mean is Double
ARGModel element (exactly one)

<poissonPrior>

Description:
Calculates the prior probability of some data under a given poisson distribution.
Rule:
Attribute mean is Double
Attribute offset is Double
Statistic elements (one or more)

<polygon>

Description:
This element represents a polygon.
Rule:
One of:
KMLCoordinates element (exactly one)
Polygon2D element (exactly one)
Attribute closed is Boolean
Attribute fillValue is Double

<poolSwapOperator>

Description:
.
Rule:
Attribute weight is Double
ValuesPool element (exactly one)

<popGraph>

Description:
This element returns a statistic that is the population size at evenly spaced intervals over tree.
Rule:
VariableDemographicModel element (exactly one)
Attribute time is Double

<popTreeModel>

Description:
Creates a Population Tree Model with specified divergence cut-off for population nodes
Rule:
TreeModel element (exactly one)
Attribute populationNodeHeight is Double

<positiveDefiniteSubstitutionModel>

Description:
A general reversible model of sequence substitution for any data type with stochastic variable selection.
Rule:
MatrixParameter element (exactly one)

<compoundLikelihood>

Description:
A likelihood function which is simply the product of its component likelihood functions.
Rule:
Attribute threads is Integer
Likelihood elements (one or more)

<precisionGibbsOperator>

Description:
This element returns a multivariate normal random walk operator on a given parameter.
Rule:
Attribute weight is Double

<compoundLikelihood>

Description:
A likelihood function which is simply the product of its component likelihood functions.
Rule:
Attribute threads is Integer
Likelihood elements (one or more)

<productStatistic>

Description:
This element returns a statistic that is the product of the child statistics.
Rule:
Attribute elementwise is Boolean
Statistic elements (one or more)

<productStatistic>

Description:
This element returns a statistic that is the product of the child statistics.
Rule:
Attribute elementwise is Boolean
Statistic elements (one or more)

<property>

Description:
This element returns an object representing the named property of the given child object.
Rule:
Attribute name is string
name of the property
Object element (exactly one)

<randomDiscretizedBranchRates>

Description:
This element returns a random discretized relaxed clock model.The branch rates are drawn from a continuous parametric distribution.
Rule:
Attribute singleRootRate is Boolean
Whether only a single rate should be used for the two children branches of the root
Attribute normalize is Boolean
Whether the mean rate has to be normalized to a particular value
Attribute normalizeBranchRateTo is Double
The mean rate to normalize to, if normalizing
TreeModel element (exactly one)
Element named distribution containing:
ParametricDistributionModel element (exactly one)
The distribution model for rates among branches
Element named rateCategoryQuantiles containing:
Parameter element (exactly one)
The quantiles for

<randomLocalClockModel>

Description:
This element returns an random local clock (RLC) model.Each branch either has a new rate or inherits the rate of the branch above it depending on the indicator vector, which is itself sampled.
Rule:
TreeModel element (exactly one)
Element named rateIndicator containing:
Parameter element (exactly one)
The rate change indicators parameter
Element named rates containing:
Parameter element (exactly one)
The rates parameter
Element named clockRate containing:
Parameter element (exactly one)
The mean rate across all local clocks
Attribute ratesAreMultipliers is Boolean

<randomLocalLogger>

Description:
A speciation model of a Yule process whose rate can evolve down the tree.
Rule:
TreeModel element (exactly one)
RandomLocalTreeVariable element (exactly one)
Attribute logEvery is Integer
Attribute fileName is String

<randomLocalLoggerOnTree>

Description:
A parser to log changed == 0 : 1 in a tree log
Rule:
RandomLocalTreeVariable element (exactly one)

<randomLocalYuleModel>

Description:
A speciation model of a Yule process whose rate can change at random nodes in the tree.
Rule:
Element named birthRates containing:
Parameter element (exactly one)
Element named indicators containing:
Parameter element (exactly one)
Element named meanRate containing:
Parameter element (exactly one)
Attribute ratesAsMultipliers is Boolean
Attribute dp is Integer
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<randomSubsetTaxa>

Description:
Defines a set of taxon objects.
Rule:
At least one of:
Taxa elements (one or more)
Taxon elements (one or more)
Attribute total is Integer
Attribute withReplacement is Boolean

<randomTaxaSample>

Description:
Randomly samples n taxa from a collection of N taxa
Rule:
Attribute sample is Integer
Taxa element (exactly one)

<randomWalk>

Description:
Describes a first-order random walk. No prior is assumed on the first data element
Rule:
Attribute logScale is Boolean
Parameter element (exactly one)
One of:
ParametricDistributionModel element (exactly one)
DistributionLikelihood element (exactly one)

<randomWalkIntegerNodeHeightWeightedOperator>

Description:
This element returns a random walk node height weighted operator on a given parameter.
Rule:
Attribute windowSize is Double
Attribute weight is Double
Parameter element (exactly one)
Element named internalNodeHeights containing:
Parameter element (exactly one)

<randomWalkIntegerOperator>

Description:
This element returns a random walk operator on a given parameter.
Rule:
Attribute windowSize is Double
Attribute weight is Double
Variable element (exactly one)

<randomWalkIntegerSetSizeWeightedOperator>

Description:
This element returns a random walk set size weighted operator on a given parameter.
Rule:
Attribute windowSize is Double
Attribute weight is Double
Attribute baseSetSize is Double
Parameter element (exactly one)
MicrosatelliteSamplerTreeModel element (exactly one)

<randomWalkOnMapOperator>

Description:
This element returns a random walk operator on a given map.
Rule:
Attribute windowSize is Double
Attribute weight is Double
Attribute autoOptimize is Boolean
MapDiffusionModel element (exactly one)
Parameter element (exactly one)

<randomWalkOperator>

Description:
This element returns a random walk operator on a given parameter.
Rule:
Attribute windowSize is Double
Attribute weight is Double
Attribute lower is Double
Attribute upper is Double
Attribute autoOptimize is Boolean
Element named updateIndex containing:
Parameter element (exactly one)
Attribute boundaryCondition ∈ {reflecting, absorbing}
null
Parameter element (exactly one)

<rateBitExchangeOperator>

Description:
This element returns a bit-flip operator on a given parameter.
Rule:
Attribute weight is Double
Element named bits containing:
Parameter element (exactly one)
Element named rates containing:
Parameter element (exactly one)

<rateCovarianceStatistic>

Description:
A statistic that has as its value the covariance of parent and child branch rates
Rule:
TreeModel element (exactly one)
BranchRateModel element (exactly one)
Attribute name is string
A name for this statistic primarily for the purposes of logging

<rateEpochBranchRates>

Description:
This element provides a multiple epoch molecular clock model. All branches (or portions of them) have the same rate of molecular evolution within a given epoch. If parameters are used to sample transition times, these must be kept in ascending order by judicious use of bounds or priors.
Rule:
Element named epoch containing:
Attribute transitionTime is Double
The time of transition between this epoch and the previous one
Parameter element (exactly one)
The evolutionary rate parameter for this epoch
Element named transitionTime containing:
Parameter element (exactly one)
The transition time parameter for this epoch
An epoch that lasts until transitionTime
Element named rate containing:
Parameter element (exactly one)
The ancestral molecular evolutionary rate parameter
Attribute continuousNormalization is Boolean
Special rate normalization for a Brownian diffusion process
Element named rootHeight containing:
Parameter element (exactly one)
The tree root height
Parameterization may require the root height

<rateExchange>

Description:
An operator that exchanges rates and traits on a tree.
Rule:
Attribute weight is Double
Attribute swapRates is Boolean
Attribute swapTraits is Boolean
Attribute swapAtRoot is Boolean
Attribute moveHeight is Boolean
TreeModel element (exactly one)

<rateSampleOperator>

Description:
This element returns a rateSample operator on a given parameter.
Rule:
Attribute weight is Double
Attribute sampleAll is Boolean
TreeModel element (exactly one)
RateEvolutionLikelihood element (zero or one)

<rateScaleOperator>

Description:
This element returns a rateScale operator on a given parameter.
Rule:
Attribute scaleFactor is Double
Attribute weight is Double
Attribute autoOptimize is Boolean
Attribute noRoot is Boolean
TreeModel element (exactly one)

<rateStatistic>

Description:
A statistic that returns the average of the branch rates
Rule:
TreeModel element (exactly one)
BranchRateModel element (exactly one)
Attribute internal is Boolean
Attribute external is Boolean
Attribute mode ∈ {mean, variance, coefficientOfVariation}
This attribute determines how the rates are summarized, can be one of (mean, variance, coefficientOfVariance)
Attribute name is string
A name for this statistic primarily for the purposes of logging

<rateVarianceScaleOperator>

Description:
This element returns a rateScale operator on a given parameter.
Rule:
Attribute scaleFactor is Double
Attribute weight is Double
Attribute autoOptimize is Boolean
TreeModel element (exactly one)
Parameter element (exactly one)

<ratioStatistic>

Description:
This element returns a statistic that is the ratio of the 2 child statistics.
Rule:
Statistic elements (exactly 2)
The two operand statistics

<ratioStatistic>

Description:
This element returns a statistic that is the ratio of the 2 child statistics.
Rule:
Statistic elements (exactly 2)
The two operand statistics

<reciprocalStatistic>

Description:
This element returns a statistic that is the element-wise reciprocal of the child statistic.
Rule:
Statistic element (exactly one)

<reciprocalStatistic>

Description:
This element returns a statistic that is the element-wise reciprocal of the child statistic.
Rule:
Statistic element (exactly one)

<recombinationSimulator>

Description:
A SequenceSimulator that generates random sequences for a given tree, sitemodel and branch rate model
Rule:
Taxa element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (zero or one)
Attribute recombinationRate is Double
Attribute ancestralPopulationSize is Double
Attribute sequenceLength is Integer

<regressionGibbsEffectOperator>

Description:
This element returns a multivariate Gibbs operator on an internal node trait.
Rule:
Attribute weight is Double
Parameter element (exactly one)
LinearRegression element (exactly one)
Element named indicator containing:
Parameter element (exactly one)

<regressionGibbsPrecisionOperator>

Description:
This element returns a multivariate Gibbs operator on an internal node trait.
Rule:
Attribute weight is Double
Parameter element (exactly one)
DistributionLikelihood element (exactly one)
LinearRegression element (exactly one)

<regressionMetropolizedIndicatorOperator>

Description:
This element returns a multivariate Gibbs operator on an internal node trait.
Rule:
Attribute weight is Double
Parameter element (exactly one)
LinearRegression element (exactly one)
Element named indicator containing:
Parameter element (exactly one)
Element named mask containing:
Parameter element (exactly one)

<report>

Description:
Generates a report using the given text and elements
Rule:
Attribute type ∈ {TEXT, XHTML}
The format of the report
Attribute title is string
The title of the report
Object elements (one or more)
An arbitrary mixture of text and elements to report
Attribute fileName is String

<RPNcalculator>

Description:
This element returns a statistic evaluated from arbitrary expression.
Rule:
Element named expression containing:
String element (exactly one)
Element named variable containing:
Statistic element (exactly one)

<sampleNonActiveOperator>

Description:
This element returns a Gibbs operator for the joint distribution of population sizes.
Rule:
Element named distribution containing:
ParametricDistributionModel element (exactly one)
Element named indicators containing:
Parameter element (exactly one)
Element named data containing:
Parameter element (exactly one)
Attribute weight is Double

<SampleQuantileLociRates>

Description:
This element returns an discretized loci rate model.The loci rates are drawn from a discretized parametric distribution.
Rule:
Attribute normalize is Boolean
Whether the mean rate has to be normalized to a particular value
Attribute normalizeMeanLociRateTo is Double
The mean rate to normalize to, if normalizing
Element named lociRates containing:
CompoundParameter element (exactly one)
The compound parameter that contains all the loci rate parameters
Element named distribution containing:
ParametricDistributionModel element (exactly one)
The distribution model for rates among branches
Element named rateQuantiles containing:
Parameter element (exactly one)
The rate quantiles parameter

<sampleStateAndCategoryModel>

Description:
A SiteModel that has a discrete distribution of substitution models over sites, designed for sampling of rate categories and internal states.
Rule:
Element named mutationRate containing:
Parameter element (exactly one)
Element named categoriesParameter containing:
Parameter element (exactly one)
SubstitutionModel elements (one or more)

<sampleStateModel>

Description:
A SiteModel that has a discrete distribution of substitution models over sites, designed for sampling of internal states.
Rule:
Element named mutationRate containing:
Parameter element (exactly one)
Element named proportions containing:
Parameter element (exactly one)
SubstitutionModel elements (one or more)

<scaledPiecewisePopulation>

Description:
This element represents a piecewise population model
Rule:
Element named populationSizes containing:
Parameter element (exactly one)
Element named populationTree containing:
TreeModel element (exactly one)
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Attribute linear is Boolean

<scaledTreeLengthModel>

Description:
This element returns a branch rate model that scales the total length of the tree to specified valued (default=1.0).
Rule:
Element named scalingFactor containing:
Parameter element (exactly one)
TreeModel element (exactly one)

<scaleOperator>

Description:
This element returns a scale operator on a given parameter.
Rule:
Attribute scaleFactor is Double
Attribute scaleAll is Boolean
Attribute scaleAllIndependently is Boolean
Attribute weight is Double
Attribute autoOptimize is Boolean
Attribute df is Integer
Parameter element (exactly one)
Element named indicators containing:
Attribute pickoneprob is Double
Parameter element (exactly one)

<selectorOperator>

Description:
.
Rule:
Attribute weight is Double
Parameter element (exactly one)

<sequence>

Description:
A biomolecular sequence.
Rule:
Taxon element (exactly one)
String element (exactly one)
A character string representing the aligned molecular sequence

<sequenceErrorModel>

Description:
This element returns a model that allows for post-mortem DNA damage.
Rule:
Attribute type is String
Element named baseErrorRate containing:
Parameter element (exactly one)
The base error rate per site per sequence
Element named ageRelatedErrorRate containing:
Parameter element (exactly one)
The error rate per site per unit time
Element named indicators containing:
Parameter element (exactly one)
A binary indicator of whether the sequence has errors
One of:
Element named include containing:
TaxonList element (exactly one)
A set of taxa to which to apply the damage model to
Element named exclude containing:
TaxonList element (exactly one)
A set of taxa to which to not apply the damage model to

<sequenceReassignment>

Description:
Operator which reassigns sequences within an allopolyploid species.
Rule:
Attribute weight is Double
AlloppSpeciesBindings element (exactly one)
AlloppSpeciesNetworkModel element (exactly one)

<sequenceSimulator>

Description:
A SequenceSimulator that generates random sequences for a given tree, sitemodel and branch rate model
Rule:
Tree element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (zero or one)
Attribute replications is Integer

<setOperator>

Description:
This element represents an operator on a set.
Rule:
Attribute set is Double;
Attribute weight is Double
Parameter element (exactly one)

<singleTipObservationProcess>

Description:
This element represents an instance of the SingleTipObservationProcess for ALSTreeLikelihood calculations
Rule:
TreeModel element (exactly one)
PatternList element (exactly one)
Taxon element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (exactly one)
Element named deathRate containing:
Parameter element (exactly one)
Element named immigrationRate containing:
Parameter element (exactly one)

<sirEpidemiology>

Description:
A demographic model of epidemic spread.
Rule:
Element named reproductiveNumber containing:
Parameter element (exactly one)
Element named recoveryRate containing:
Parameter element (exactly one)
Element named hostPopulationSize containing:
Parameter element (exactly one)
Element named proportions containing:
Parameter element (exactly one)
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<siteModel>

Description:
A SiteModel that has a gamma distributed rates across sites
Rule:
Element named substitutionModel containing:
SubstitutionModel element (exactly one)
One of:
Element named mutationRate containing:
Parameter element (exactly one)
Element named relativeRate containing:
Parameter element (exactly one)
Element named gammaShape containing:
Attribute gammaCategories is Integer
Parameter element (exactly one)
Element named proportionInvariant containing:
Parameter element (exactly one)

<gmrfSkyrideLikelihood>

Description:
This element represents the likelihood of the tree given the population size vector.
Rule:
Element named populationSizes containing:
Parameter element (exactly one)
Element named precisionParameter containing:
Parameter element (exactly one)
Element named phiParameter containing:
Parameter element (exactly one)
Element named populationTree containing:
TreeModel elements (one or more)
Element named groupSizes containing:
Parameter element (exactly one)
Attribute rescaleByRootHeight is Boolean
Attribute randomizeTree is Boolean
Attribute timeAwareSmoothing is Boolean
Attribute oldSkyride is Boolean

<slidingPatternsOperator>

Description:
This element returns a sliding window operator on alignment sites.
Rule:
Attribute windowSize is Integer
Attribute weight is Integer
Attribute autoOptimize is Boolean
Element named breakPoints containing:
Parameter element (exactly one)
SitePatterns elements ( to 100)

<sp>

Description:
Taxon in a species tree
Rule:
Taxon elements (one or more)

<speciationLikelihood>

Description:
This element represents the likelihood of the tree given the speciation.
Rule:
Element named model containing:
SpeciationModel element (exactly one)
Element named speciesTree containing:
Tree element (exactly one)
Element named include containing:
Taxa elements (one or more)
One or more subsets of taxa which should be included from calculate the likelihood (the remaining taxa are excluded)
Element named exclude containing:
Taxa elements (one or more)
One or more subsets of taxa which should be excluded from calculate the likelihood (which is calculated on the remaining subtree)
Element named calibration containing:
Attribute correction is String
Statistic element (zero or one)
One of:
Distribution elements (one to 100)
DistributionLikelihood elements (one to 100)
Taxa elements (one to 100)
Element named point containing:
Attribute forParent is Boolean
One of:
Distribution element (exactly one)
DistributionLikelihood element (exactly one)
Taxa element (exactly one)

<species>

Description:
Binds taxa in gene trees with species information.
Rule:
SpeciesBindings$SPinfo elements ( or more)
Element named geneTrees containing:
TreeModel elements (zero or more)
Element named gtree containing:
Attribute ploidy is Double
TreeModel element (exactly one)

<speciesCoalescent>

Description:
Compute coalecent log-liklihood of a set of gene trees embedded inside one species tree.
Rule:
SpeciesBindings element (exactly one)
SpeciesTreeModel element (exactly one)

<speciesTree>

Description:
Species tree which includes demographic function per branch.
Rule:
Attribute bmPrior is Boolean
Attribute constantRoot is Boolean
Attribute constantPopulation is Boolean
SpeciesBindings element (exactly one)
Tree element (zero or one)
Element named sppSplitPopulations containing:
Attribute value is Double
Parameter element (exactly one)
Element named coalescentPointsPopulations containing:
Attribute value is Double
Parameter element (exactly one)
Element named coalescentPointsIndicators containing:
Parameter element (exactly one)

<speciesTreePopulationPrior>

Description:
Rule:
SpeciesTreeModel element (exactly one)
Element named tipsDistribution containing:
ParametricDistributionModel element (exactly one)
Element named sigma containing:
Parameter element (exactly one)

<speciesTreeStatistic>

Description:
A statistic that returns true if the given population tree is compatible with the species tree. Compatibility is defined as the compatibility of the timings of the events, so that incompatibility arises if two individuals in the population tree coalescent before their species do in the species tree.
Rule:
Attribute name is string
A name for this statistic primarily for the purposes of logging
Element named speciesTree containing:
Tree element (exactly one)
Element named populationTree containing:
Tree element (exactly one)

<splitTraitBySite>

Description:
null
Rule:
AncestralStateBeagleTreeLikelihood element (exactly one)
The tree which is to be logged
Attribute traitName is String
Attribute scaleByBranchLength is Boolean

<starTreeModel>

Description:
This element represents a model of the tree. The tree model includes and attributes of the nodes including the age (or height) and the rate of evolution at each node in the tree.
Rule:
Tree element (exactly one)
Element named rootHeight containing:
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named leafHeight containing:
Attribute taxon is String
The name of the taxon for the leaf
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named nodeTraits containing:
Attribute name is String
The name of the trait attribute in the taxa
Attribute rootNode is Boolean
If true the root trait is included in the parameter
Attribute internalNodes is Boolean
If true the internal node traits (minus the root) are included in the parameter
Attribute leafNodes is Boolean
If true the leaf node traits are included in the parameter
Attribute traitDimension is Integer
The number of dimensions (if multivariate)
Attribute initialValue is Double
The initial value(s)
Attribute fireTreeEvents is Boolean
Whether to fire tree events if the traits change
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named nodeRates containing:
Attribute rootNode is Boolean
If true the root rate is included in the parameter
Attribute internalNodes is Boolean
If true the internal node rate (minus the root) are included in the parameter
Attribute leafNodes is Boolean
If true the leaf node rate are included in the parameter
Attribute initialValue is Double
The initial value(s)
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named leafTrait containing:
Attribute taxon is String
The name of the taxon for the leaf
Attribute name is String
The name of the trait attribute in the taxa
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Example:
<!-- the tree model as special sockets for attaching parameters to various aspects of the tree     -->
<!-- The treeModel below shows the standard setup with a parameter associated with the root height -->
<!-- a parameter associated with the internal node heights (minus the root height) and             -->
<!-- a parameter associates with all the internal node heights                                     -->
<!-- Notice that these parameters are overlapping                                                  -->
<!-- The parameters are subsequently used in operators to propose changes to the tree node heights -->
<treeModel id="treeModel1">
	<tree idref="startingTree"/>
	<rootHeight>
		<parameter id="treeModel1.rootHeight"/>
	</rootHeight>
	<nodeHeights internalNodes="true" rootNode="false">
		<parameter id="treeModel1.internalNodeHeights"/>
	</nodeHeights>
	<nodeHeights internalNodes="true" rootNode="true">
		<parameter id="treeModel1.allInternalNodeHeights"/>
	</nodeHeights>
</treeModel>

<statistic>

Description:
A statistic of a given name from the specified object.
Rule:
Attribute name is string
The name of the statistic you wish to extract from the given object
StatisticList element (exactly one)

<steppingStoneSamplingAnalysis>

Description:
Performs a trace analysis.
Rule:
Attribute fileName is string
The traceName of a BEAST log file (can not include trees, which should be logged separately)
Element named thetaColumn containing:
Attribute name is string
The column name
Element named likelihoodColumn containing:
Attribute name is string
The column name

<STPopulationPrior>

Description:
Rule:
Attribute log_root is Boolean
SpeciesTreeModel element (exactly one)
Element named tipsDistribution containing:
ParametricDistributionModel element (exactly one)
Element named sigma containing:
Parameter element (exactly one)
Element named STsigma containing:
Parameter element (exactly one)

<strictClockBranchRates>

Description:
This element provides a strict clock model. All branches have the same rate of molecular evolution.
Rule:
Element named rate containing:
Parameter element (exactly one)
The molecular evolutionary rate parameter

<string>

Description:
returns a String. If a prompt attribute exists then the user is prompted for input, otherwise the character contents of the element are returned.
Rule:
One of:
Attribute prompt is string
A message displayed to the user when entering a value for this string
String element (exactly one)

<structuredCoalescentLikelihood>

Description:
This element represents a likelihood function for transmission.
Rule:
TreeModel element (exactly one)
The tree.
ColourSamplerModel element (exactly one)
The colour sampler model.
MigrationModel element (exactly one)
The migration model.
MetaPopulationModel element (exactly one)
The meta-population model.

<subStatistic>

Description:
Allows you to choose specific dimensions of a given statistic
Rule:
Attribute dimension is Integer;
Statistic element (exactly one)

<substitutionEpochModel>

Description:
null
Rule:
Element named models containing:
AbstractSubstitutionModel elements (one or more)
Parameter element (exactly one)

<subtreeSlide>

Description:
An operator that slides a subtree.
Rule:
Attribute weight is Double
Attribute size is Double
Attribute targetAcceptance is Double
Attribute gaussian is Boolean
Attribute swapInRandomRate is Boolean
Attribute swapInRandomTrait is Boolean
Attribute autoOptimize is Boolean
TreeModel element (exactly one)

<sumStatistic>

Description:
This element returns a statistic that is the element-wise sum of the child statistics.
Rule:
Attribute elementwise is Boolean
Attribute name is String
Statistic elements (one or more)

<sumStatistic>

Description:
This element returns a statistic that is the element-wise sum of the child statistics.
Rule:
Attribute elementwise is Boolean
Attribute name is String
Statistic elements (one or more)

<generalSubstitutionModel>

Description:
A general reversible model of sequence substitution for any data type.
Rule:
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The type of sequence data
DataType element (exactly one)
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)
Element named rateIndicator containing:
Parameter element (exactly one)
Attribute randomizeIndicator is Boolean

<generalSubstitutionModel>

Description:
A general reversible model of sequence substitution for any data type.
Rule:
One of:
Attribute dataType ∈ {binary, hiddenNucleotide, codon-vertebrateMitochondrial, hiddenNucleotide2, hiddenCodon2-universal, hiddenNucleotide1, codon-yeast, twoStateCovarion, codon-blepharismaNuclear, continuous, codon-noStops, generalDataType, codon-universal, hiddenCodon3-universal, codon-bacterial, codon-flatwormMitochondrial, codon-ciliate, codon-moldProtozoanMitochondrial, codon-alternativeYeast, codon-euplotidNuclear, codon-echinodermMitochondrial, codon-ascidianMitochondrial, P2P, amino acid, codon-invertebrateMitochondrial, codon-mycoplasma, nucleotide, microsatellite}
The type of sequence data
DataType element (exactly one)
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)
Element named rateIndicator containing:
Parameter element (exactly one)
Attribute randomizeIndicator is Boolean

<swapOperator>

Description:
This element represents an operator that swaps values in a multi-dimensional parameter.
Rule:
Attribute weight is Double
Attribute size is Integer
Attribute autoOptimize is Boolean
Parameter element (exactly one)

<taxa>

Description:
Defines a set of taxon objects.
Rule:
At least one of:
Taxa elements (one or more)
Taxon elements (one or more)
Example:
<!-- A list of six taxa -->
<taxa id="greatApes">
	<taxon id="human"/>
	<taxon id="chimp"/>
	<taxon id="bonobo"/>
	<taxon id="gorilla"/>
	<taxon id="orangutan"/>
	<taxon id="siamang"/>
</taxa>

<!-- A list of three taxa by references to above taxon objects -->
<taxa id="humanAndChimps">
	<taxon idref="human"/>
	<taxon idref="chimp"/>
	<taxon idref="bonobo"/>
</taxa>

<taxon>

Description:
Rule:
Attribute id is string
A unique identifier for this taxon
Attribute$Default element (zero or one)
Date element (zero or one)
Location element (zero or one)

<teamOperator>

Description:
An arbitrary list of operators; A random subset of size N is aggregated in one operation. Operators may have unequal weights - in that case a subset probability of selection is proportional to the sum of it's members weights.
Rule:
MCMCOperator elements (one or more)
Attribute weight is Double
Attribute size is Integer

<test>

Description:
This element represents a boolean statistic that returns 1 if the conditions are met and 0 otherwise.
Rule:
Attribute name is string
A name for this statistic, for logging purposes
Attribute element (exactly one)
One of:
Element named equals containing:
Attribute element (exactly one)
Element named greaterThan containing:
Attribute element (exactly one)
Element named lessThan containing:
Attribute element (exactly one)
Attribute equals is Double
Attribute greaterThan is Double
Attribute lessThan is Double
Attribute inside is Double;
Attribute outside is Double;

<threadedCompoundLikelihood>

Description:
A likelihood function which is simply the product of its component likelihood functions.
Rule:
Likelihood elements (one or more)
Attribute robustWeight is Double

<tipBranchRateModel>

Description:
This element returns a branch rate model that has a different rate for external branches than internal.
Rule:
Element named externalRate containing:
Parameter element (exactly one)
The molecular evolutionary rate parameter for external branches
Element named internalRate containing:
Parameter element (exactly one)
The molecular evolutionary rate parameter for internal branches

<tipHeightLikelihood>

Description:
Calculates the likelihood of the tipHeights given some parametric or empirical distribution.
Rule:
Element named distribution containing:
ParametricDistributionModel element (exactly one)
Element named tipHeights containing:
Parameter element (exactly one)

<tipStateSwapOperator>

Description:
This element represents an operator to swap tip states between two random tips.
Rule:
Attribute weight is Double
TreeLikelihood element (exactly one)

<tipTraitSwapOperator>

Description:
This element represents an operator to swap tip traits between two random tips.
Rule:
Attribute trait is String
Attribute weight is Double

<tkf91Likelihood>

Description:
Returns the total likelihood of a single alignment under the TKF91 model, for a given tree. In particular all possible ancestral histories of insertions and deletions leading to the alignment of sequences at the tips are taken into account.
Rule:
TreeModel element (exactly one)
Alignment element (exactly one)
GammaSiteModel element (exactly one)
TKF91Model element (exactly one)

<tkf91Model>

Description:
The TKF91 (Thorne, Kishino & Felsenstein 1991) model of insertion-deletion.
Rule:
Element named lengthDistribution containing:
Parameter element (exactly one)
Element named deathRate containing:
Parameter element (exactly one)
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<tmrcaStatistic>

Description:
A statistic that has as its value the height of the most recent common ancestor of a set of taxa in a given tree
Rule:
Tree element (exactly one)
Attribute name is string
A name for this statistic primarily for the purposes of logging
Attribute rate is Boolean
Element named mrca containing:
Taxa element (exactly one)
At least one of:
Attribute forParent is Boolean
Attribute includeStem is Boolean

<TN93Model>

Description:
This element represents an instance of the TN93 (Tamura and Nei 1993) model of nucleotide evolution.
Rule:
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named kappa1 containing:
Variable element (exactly one)
Element named kappa2 containing:
Variable element (exactly one)

<argPartitionOperator>

Description:
An operator that picks a new partitioning uniformly at random.
Rule:
Attribute weight is Integer
Attribute tossSize is Integer
Attribute tossAll is Boolean
ARGModel element (exactly one)

<traceAnalysis>

Description:
Performs a trace analysis. Estimates the mean of the various statistics in the given log file.
Rule:
Attribute fileName is string
The name of a BEAST log file (can not include trees, which should be logged separately
Attribute burnIn is Integer
Element named expectation containing:
Attribute name is String
Attribute value is String
Attribute stdError is Boolean
Attribute computeMSE is Boolean

<traitGibbsOperator>

Description:
This element returns a multivariate Gibbs operator on traits for possible all nodes.
Rule:
Attribute weight is Double
Attribute onlyInternalNodes is Boolean
Attribute onlyTipsWithPriors is Boolean
MultivariateDistributionLikelihood elements (zero or more)
Element named rootPrior containing:
GeoSpatialCollectionModel element (zero or one)

<traitRateGibbsOperator>

Description:
This element returns a multivariate Gibbs operator on traits for possible all nodes.
Rule:
Attribute weight is Double
ArbitraryBranchRates element (exactly one)
DistributionLikelihood element (exactly one)

<transmissionHistory>

Description:
Defines a transmission history
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
Element named transmission containing:
Parameter element (exactly one)
Element named donor containing:
Taxon element (exactly one)
Element named recipient containing:
Taxon element (exactly one)

<transmissionLikelihood>

Description:
This element represents a likelihood function for transmission.
Rule:
Element named sourcePatient containing:
DemographicModel element (exactly one)
This describes the demographic process for the source donor patient.
TransmissionDemographicModel element (exactly one)
This describes the demographic process for the recipient patients.
One of:
Element named hostTree containing:
Tree element (exactly one)
TransmissionHistoryModel element (exactly one)
This describes the transmission history of the patients.
Element named parasiteTree containing:
Tree element (exactly one)

<transmissionModel>

Description:
A SiteModel that has a gamma distributed rates across sites
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
One of:
Element named constant containing:
Element named populationSize containing:
Parameter element (exactly one)
This parameter represents the carrying capacity (maximum population size). If the shape is very large then the current day population size will be very close to the carrying capacity.
One of:
Element named exponential containing:
One of:
Element named growthRate containing:
Parameter element (exactly one)
This parameter determines the rate of growth during the exponential phase. See exponentialGrowth for details.
Element named doublingTime containing:
Parameter element (exactly one)
This parameter determines the doubling time at peak growth rate.
Element named ancestralProportion containing:
Parameter element (exactly one)
This parameter determines the populaation size at transmission.
Element named logistic containing:
Element named populationSize containing:
Parameter element (exactly one)
This parameter represents the carrying capacity (maximum population size). If the shape is very large then the current day population size will be very close to the carrying capacity.
One of:
Element named growthRate containing:
Parameter element (exactly one)
This parameter determines the rate of growth during the exponential phase. See exponentialGrowth for details.
Element named doublingTime containing:
Parameter element (exactly one)
This parameter determines the doubling time at peak growth rate.
Element named ancestralProportion containing:
Parameter element (exactly one)
This parameter determines the populaation size at transmission.

<transmissionStatistic>

Description:
A statistic that returns true if the given parasite tree is compatible with the host tree.
Rule:
Attribute name is string
A name for this statistic for the purpose of logging
One of:
Element named hostTree containing:
Tree element (exactly one)
TransmissionHistoryModel element (exactly one)
This describes the transmission history of the patients.
Element named parasiteTree containing:
Tree element (exactly one)

<tree>

Description:
This element represents a rooted binary tree and associated attributes.
Rule:
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units
SimpleNode element (exactly one)

<treeBitMoveOperator>

Description:
This element returns a bit-move operator on a given parameter.
Rule:
Attribute weight is Double
TreeModel element (exactly one)
Attribute indicatorTrait is String
Attribute trait2 is String

<treeBitRandomWalk>

Description:
This element returns a bit-random walk operator on a random indicator/variable pair in the tree.
Rule:
Attribute weight is Double
TreeModel element (exactly one)
Attribute indicatorTrait is String
Attribute trait2 is String
Attribute swapTrait2 is Boolean
Attribute k is Integer

<treeColouringOperator>

Description:
A tree colouring model.
Rule:
ColourSamplerModel element (exactly one)

<diffusionRateStatistic>

Description:
A statistic that returns the average of the branch rates
Rule:
Attribute name is String
Attribute greatCircleDistance is Boolean

<treeHeightStatistic>

Description:
A statistic that returns the height of the tree
Rule:
Attribute name is String
TreeModel element (exactly one)

<treeLengthStatistic>

Description:
A statistic that returns the average of the branch rates
Rule:
Attribute name is String
TreeModel element (exactly one)

<treeLikelihood>

Description:
This element represents the likelihood of a patternlist on a tree given the site model.
Rule:
Attribute useAmbiguities is Boolean
Attribute allowMissingTaxa is Boolean
Attribute storePartials is Boolean
Attribute forceJavaCore is Boolean
Attribute forceRescaling is Boolean
PatternList element (exactly one)
TreeModel element (exactly one)
SiteModel element (exactly one)
BranchRateModel element (zero or one)
TipStatesModel element (zero or one)

<treeMetricStatistic>

Description:
A statistic that returns the distance between two trees. with method="topology", return a 0 for identity and a 1 for difference. With other methods return the distance metric associated with that method.
Rule:
Attribute name is string
A name for this statistic primarily for the purposes of logging
Attribute method is string
comparision method (TOPOLOGY,BILLERA,ROBINSONSFOULD,CLADEHEIGHTM,BRANCHSCORE,CLADEMETRIC)
Element named target containing:
Tree element (exactly one)
Element named reference containing:
Tree element (exactly one)

<treeModel>

Description:
This element represents a model of the tree. The tree model includes and attributes of the nodes including the age (or height) and the rate of evolution at each node in the tree.
Rule:
Tree element (exactly one)
Element named rootHeight containing:
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named nodeHeights containing:
Attribute rootNode is Boolean
If true the root height is included in the parameter
Attribute internalNodes is Boolean
If true the internal node heights (minus the root) are included in the parameter
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named leafHeight containing:
Attribute taxon is String
The name of the taxon for the leaf
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named nodeTraits containing:
Attribute name is String
The name of the trait attribute in the taxa
Attribute rootNode is Boolean
If true the root trait is included in the parameter
Attribute internalNodes is Boolean
If true the internal node traits (minus the root) are included in the parameter
Attribute leafNodes is Boolean
If true the leaf node traits are included in the parameter
Attribute traitDimension is Integer
The number of dimensions (if multivariate)
Attribute initialValue is Double
The initial value(s)
Attribute fireTreeEvents is Boolean
Whether to fire tree events if the traits change
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named nodeRates containing:
Attribute rootNode is Boolean
If true the root rate is included in the parameter
Attribute internalNodes is Boolean
If true the internal node rate (minus the root) are included in the parameter
Attribute leafNodes is Boolean
If true the leaf node rate are included in the parameter
Attribute initialValue is Double
The initial value(s)
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Element named leafTrait containing:
Attribute taxon is String
The name of the taxon for the leaf
Attribute name is String
The name of the trait attribute in the taxa
Parameter element (exactly one)
A parameter definition with id only (cannot be a reference!)
Example:
<!-- the tree model as special sockets for attaching parameters to various aspects of the tree     -->
<!-- The treeModel below shows the standard setup with a parameter associated with the root height -->
<!-- a parameter associated with the internal node heights (minus the root height) and             -->
<!-- a parameter associates with all the internal node heights                                     -->
<!-- Notice that these parameters are overlapping                                                  -->
<!-- The parameters are subsequently used in operators to propose changes to the tree node heights -->
<treeModel id="treeModel1">
	<tree idref="startingTree"/>
	<rootHeight>
		<parameter id="treeModel1.rootHeight"/>
	</rootHeight>
	<nodeHeights internalNodes="true" rootNode="false">
		<parameter id="treeModel1.internalNodeHeights"/>
	</nodeHeights>
	<nodeHeights internalNodes="true" rootNode="true">
		<parameter id="treeModel1.allInternalNodeHeights"/>
	</nodeHeights>
</treeModel>

<treeShapeStatistics>

Description:
A statistic that reports a handful of tree shape statistics on the given target tree.
Rule:
Attribute name is string
A name for this statistic primarily for the purposes of logging
Element named target containing:
TreeModel element (exactly one)

<treeTraceAnalysis>

Description:
Analyses and reports on a trace consisting of trees.
Rule:
Attribute fileName is string
name of a tree log file
Attribute burnIn is Integer
Attribute minCladeProbability is Double
Attribute credSetProbability is Double
Attribute shortReport is Boolean
Attribute referenceTree is String

<treeUniform>

Description:
Simultanouesly change height of two nodes.
Rule:
Attribute weight is Double
Attribute count is Integer
TreeModel element (exactly one)

<twoEpoch>

Description:
A demographic model of two epochs.
Rule:
Element named modernEpoch containing:
DemographicModel element (exactly one)
The demographic model for the recent epoch.
Element named ancientEpoch containing:
DemographicModel element (exactly one)
The demographic model for the ancient epoch.
Element named transitionTime containing:
Parameter element (exactly one)
The time that splits the two epochs.
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units

<twoPartDistribution>

Description:
Calculates the likelihood of some data given some parametric or empirical distribution.

<TWOPHASEModel>

Description:
This element represents an instance of the Two Phase Model of microsatellite evolution.
Rule:
Microsatellite element (exactly one)
Element named frequencies containing:
FrequencyModel element (exactly one)
Element named Submodel containing:
OnePhaseModel element (exactly one)
Element named OnePhasePrParam containing:
Parameter element (exactly one)
Element named GeoParam containing:
Parameter element (exactly one)
Element named TransformParam containing:
Parameter element (exactly one)
Attribute estimateSubmodelParameters is string
whether or not to esitmate the parameters of the submodel

<UCLikelihood>

Description:
This element returns an object that can calculate the likelihood of rates in a tree under the assumption of (log)normally distributed rates.
Rule:
TreeModel element (exactly one)
Element named rates containing:
Parameter element (exactly one)
The branch rates parameter
Attribute logspace is Boolean
true if model considers the log of the rates.
Element named rootRate containing:
Parameter element (exactly one)
The root rate parameter
Element named variance containing:
Parameter element (exactly one)
The standard deviation of the (log)normal distribution

<uniformDistributionModel>

Description:
Describes a uniform distribution with a given lower and upper bounds
Rule:
Element named lower containing:
One of:
Parameter element (exactly one)
Double element (exactly one)
Element named upper containing:
One of:
Parameter element (exactly one)
Double element (exactly one)

<uniformIntegerOperator>

Description:
An operator that picks new parameter values uniformly at random.
Rule:
Attribute weight is Double
Attribute upper is Double
Attribute lower is Double
Attribute count is Double
Variable element (exactly one)

<uniformNodeHeightPrior>

Description:
This element represents the likelihood of the tree given the demographic function.
Rule:
Attribute analytic is Boolean
Attribute maxRootHeight is Double
Attribute mcSampleSize is Integer
Attribute marginal is Boolean
Attribute approximate is Boolean
TreeModel element (exactly one)

<uniformOperator>

Description:
An operator that picks new parameter values uniformly at random.
Rule:
Attribute weight is Double
Attribute lower is Double
Attribute upper is Double
Parameter element (exactly one)

<uniformPartitionLikelihood>

Description:
null
Rule:
ARGModel element (exactly one)

<uniformPrior>

Description:
Calculates the prior probability of some data under a given uniform distribution.
Rule:
Attribute lower is Double
Attribute upper is Double
Statistic elements (one or more)

<uniformNodeHeightPrior>

Description:
This element represents the likelihood of the tree given the demographic function.
Rule:
Attribute analytic is Boolean
Attribute maxRootHeight is Double
Attribute mcSampleSize is Integer
Attribute marginal is Boolean
Attribute approximate is Boolean
TreeModel element (exactly one)

<upDownOperator>

Description:
This element represents an operator that scales two parameters in different directions. Each operation involves selecting a scale uniformly at random between scaleFactor and 1/scaleFactor. The up parameter is multipled by this scale and the down parameter is divided by this scale.
Rule:
Attribute scaleFactor is Double
Attribute weight is Double
Attribute autoOptimize is Boolean
Element named up containing:
Scalable element (zero or one)
Parameter element (zero or one)
Element named scale containing:
Attribute count is Integer
Attribute df is Integer
Scalable element (exactly one)
Element named down containing:
Scalable element (zero or one)
Parameter element (zero or one)
Element named scale containing:
Attribute count is Integer
Attribute df is Integer
Scalable element (exactly one)

<upgmaTree>

Description:
This element returns a UPGMA tree generated from the given distances.
Rule:
Attribute usingDates is Boolean
Attribute rootHeight is Double
Attribute nonzeroBranchLengths is Boolean
DistanceMatrix element (exactly one)

<variableDemographic>

Description:
This element represents the likelihood of the tree given the population size vector.
Rule:
Attribute type is String
Attribute logUnits is Boolean
Attribute useMidpoints is Boolean
Element named populationSizes containing:
Parameter element (exactly one)
Element named indicators containing:
Parameter element (exactly one)
Element named trees containing:
Element named ptree containing:
Attribute ploidy is Double
TreeModel element (exactly one)

<varianceStatistic>

Description:
This element returns a statistic that is the variance of the child statistics.
Rule:
Statistic elements (one or more)

<VDAnalysis>

Description:
reconstruct population graph from EBSP run.
Rule:
Attribute burnIn is Double
The number of states (not sampled states, but actual states) that are discarded from the beginning of the trace and are excluded from the analysis
Attribute Confidencelevels is Double;
Attribute useQuantiles is Boolean
Attribute logUnits is Boolean
Attribute useMidpoints is Boolean
Attribute nBins is Integer
Attribute nChanges is Integer
Element named logFileName containing:
String element (exactly one)
The name of a BEAST log file
Element named treeFileNames containing:
Element named treeOfLoci containing:
String element (exactly one)
The name of a BEAST trees log file
Element named populationModelType containing:
String element (exactly one)
population model type (stepwise, linear ...
Element named populationFirstColumn containing:
String element (exactly one)
Name of first column of population size
Element named indicatorsFirstColumn containing:
String element (exactly one)
Name of first column of population indicators
Element named rootheightColumn containing:
String element (exactly one)
Name of trace column of root height
Element named allDemographicsFileName containing:
String element (exactly one)
Name of file to output all demographic functions

<vectorSlice>

Description:
A vector parameter constructed from a slice of component parameters.
Rule:
Parameter elements (one or more)
Attribute sliceDimension is Integer

<vonMisesFisherDiffusionModel>

Description:
Describes a von Mises-Fisher distributed diffusion process on a sphere.
Rule:
Element named kappa containing:
Parameter element (exactly one)

<wanderingTaxonLogger>

Description:
null
Rule:
Attribute name is String
Attribute relative is String
Taxon element (exactly one)

<wideExchange>

Description:
This element represents a wide exchange operator. This operator swaps two random subtrees.
Rule:
Attribute weight is Double
TreeModel element (exactly one)

<wilsonBalding>

Description:
An operator which performs the Wilson-Balding move on a tree
Rule:
Attribute weight is Double
TreeModel element (exactly one)

<yangCodonModel>

Description:
This element represents the Yang model of codon evolution.
Rule:
Attribute geneticCode ∈ {universal, vertebrateMitochondrial, yeast, moldProtozoanMitochondrial, invertebrateMitochondrial, ciliate, echinodermMitochondrial, euplotidNuclear, bacterial, alternativeYeast, ascidianMitochondrial, flatwormMitochondrial, blepharismaNuclear, noStops}
The genetic code to use
Element named omega containing:
Parameter element (exactly one)
Element named kappa containing:
Parameter element (exactly one)
FrequencyModel element (exactly one)

<yuleModel>

Description:
A speciation model of a simple constant rate Birth-death process.
Rule:
Attribute conditionalOnRoot is Boolean
Element named birthRate containing:
Parameter element (exactly one)
Attribute units ∈ {substitutions, mutations, generations, days, months, years}
the units