debarcode_mass_cytometry
CATALYST single-cell debarcoding of a barcoded mass cytometry FCS file in the project, with a barcoding key (a CSV: barcode id, then one 0/1 column per barcode mass): each event's barcode from the order of its asinh-transformed barcode channels, the channels scaled per barcode by the 95th percentile of its positive values, events whose separation is below the cutoff (one for every barcode, or each barcode's own estimated from its yield curve, estCutoffs) or whose Mahalanobis distance from their barcode's population exceeds the cutoff unassigned; per-barcode yields.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "debarcode_mass_cytometry"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | the barcoding key CSV in the project, by name or id; empty when the project holds one. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| gating | No | a Gating-ML or FlowJo .wsp in the project; empty for none. | |
| derived | No | as analyze_flow_cytometry. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| document | No | the FCS file in the project, by name or id. | |
| mhl_cutoff | No | the Mahalanobis distance beyond which an event is unassigned; CATALYST's 30. | |
| sep_cutoff | No | the separation below which an event is unassigned; 0.35 is CATALYST's example. | |
| compensation | No | as analyze_flow_cytometry. | auto |
| barcode_cofactor | No | barcode intensities read as asinh(x / barcode_cofactor); CATALYST's 5. | |
| estimate_cutoffs | No | estimate each barcode's separation cutoff from its yield curve (CATALYST estCutoffs: a three-parameter log-logistic and a linear fit, weighted by their residuals) instead of sep_cutoff. | |
| compensation_method | No | as analyze_flow_cytometry. | flowkit |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| yields | Yes | per barcode: events assigned before and after the cutoffs, and the cutoff used (estimated or given) | |
| unassigned | Yes | events left unassigned |