create_traitset

Takes an airr clone object and returns BEAST2 XML for a trait/traitSet from a column

Provides a set of functions for inferring, visualizing, and analyzing B cell phylogenetic trees.
Provides methods to 1) reconstruct unmutated ancestral sequences,
2) build B cell phylogenetic trees using multiple methods,
3) visualize trees with metadata at the tips,
4) reconstruct intermediate sequences,
5) detect biased ancestor-descendant relationships among metadata types
Workflow examples available at documentation site (see URL).
Citations:
Hoehn et al (2022) <doi:10.1371/journal.pcbi.1009885>,
Hoehn et al (2021) <doi:10.1101/2021.01.06.425648>.

Kenneth Hoehn

dowser

B Cell Receptor Phylogenetics Toolkit

Cole Jensen

Jessie Fielding

Hunter Melton

Susanna Marquez

Jason Vander Heiden

Steven Kleinstein

create_traitset function

<dl><dt>clone</dt>
<dd>an <code>airrClone</code> object</dd>
<dt>trait_name</dt>
<dd>name of the trait</dd>
<dt>column</dt>
<dd>column in the clone data to use for the trait</dd>
<dt>id</dt>
<dd>unique identifer for this analysis</dd>
<dt>trait_data_type</dt>
<dd>optional data type for the trait</dd>
<dt>isSet</dt>
<dd>is this a traitSet (TRUE) or a trait (FALSE)?</dd>
<dt>include_germline_as_tip</dt>
<dd>include the germline as a tip</dd></dl>

Arguments

Takes an airr clone object and returns BEAST2 XML for a trait/traitSet from a column — create_traitset

<dl>

<dt>clone</dt>
<dd>an <code>airrClone</code> object</dd>


<dt>trait_name</dt>
<dd>name of the trait</dd>


<dt>column</dt>
<dd>column in the clone data to use for the trait</dd>


<dt>id</dt>
<dd>unique identifer for this analysis</dd>


<dt>trait_data_type</dt>
<dd>optional data type for the trait</dd>


<dt>isSet</dt>
<dd>is this a traitSet (TRUE) or a trait (FALSE)?</dd>


<dt>include_germline_as_tip</dt>
<dd>include the germline as a tip</dd>

</dl>

create_traitset: Takes an airr clone object and returns BEAST2 XML for a trait/traitSet from a column

Description

Usage

Value

Arguments