VDJ_dynamics: Tracks a specific VDJ column across multiple...

In Platypus: Single-Cell Immune Repertoire and Gene Expression Analysis

Tracks a specific VDJ column across multiple samples/timepoints.

Description

Track a VDJ column across multiple samples or timepoints. Tracking consists of creating a per sample/timepoint dataframe of unique values for the VDJ column and their respective counts inside that timepoints/repertoire. Also creates alluvial plots to show the temporal dynamics of the tracked elements.

Usage

VDJ_dynamics(
  VDJ,
  columns.to.track,
  starting.point.repertoire,
  track.all.elements,
  track.only.common,
  max.elements.to.track,
  specific.elements.to.track,
  additional.grouping.column,
  max.additional.groups,
  specific.additional.groups,
  timepoints.column,
  proportions.level,
  output.format,
  ignore.legend
)

Arguments

VDJ	VDJ or VDJ.GEX.matrix[[1]] object, as obtained from the VDJ_GEX_matrix function in Platypus.
columns.to.track	string or list of strings - VDJ column with values to track (e.g., 'VDJ_cgene' will track the changes in isotype counts/proportions across multiple timepoints, defined by the timepoints.column). If two columns are provided and tracked, then a new values will be created by combining the values from each column.
starting.point.repertoire	string or integer - the repertoire from which to start tracking (1 = will start at the first repertoire, 's3' will start at repertoire 's3').
track.all.elements	boolean - if T (and track.only.common=F), it will track all elements across all repertoires/timepoints.
track.only.common	boolean - if T (and track.all.elements=F), it will only track the common elements across all repertoires/timepoints.
max.elements.to.track	integer or NULL - the maximum number of elements to track (elements are first sorted by frequency/abundance). If NULL, it will track all elements.
specific.elements.to.track	vector of strings or NULL - specific elements we want tracked. If NULL, all elements will be tracked.
additional.grouping.column	string or 'none' - VDJ column for calculating the frequency/counts of elements on a per-group level. If output.format='plot', each unique group will have its own bar plot of timepoints/repertoires (x axis) and feature counts (y axis). If NULL, no additional grouping will be done.
max.additional.groups	integer or NULL - the maximum number of additional groups to consider (groups are first ordered by their frequency = total number of cells in that group in the VDJ matrix). If NULL, all groups will be considered.
specific.additional.groups	vector of strings or NULL - specific grouping factors we want to consider. If NULL, all grouping factors will be considered.
timepoints.column	string - VDJ column with either timepoints or repertoires across which we want to track our elements (usually 'sample_id').
proportions.level	string - 'absolute.counts' for absolute counts, 'group' for per group proportions, 'repertoire' for per repertoire/timepoint proportions.
output.format	string - 'plot' for alluvial barplots, 'df' for count/proportions dataframes of the tracked elements.
ignore.legend	boolean - if T, the legend will not be included in the resulting ggplot object.

Value

Either a count dataframe of the tracked elements across multiple timepoints/repertoires, or alluvial barplot.

Examples

VDJ_dynamics(VDJ = Platypus::small_vgm[[1]],
columns.to.track='clonotype_id', starting.point.repertoire=1,
max.elements.to.track=10, timepoints.column='sample_id',
output.format='plot')

Platypus documentation built on Oct. 18, 2024, 5:08 p.m.