simulate_characters
Simulate character matrices for lineage tracing using stochastic Cas9-style mutations on a simulated tree, with configurable rates, cassettes, and optional missing data or noise.
Instructions
Simulate a lineage-tracing character matrix on a dataset's simulated tree.
Populates obsm["characters"] via stochastic Cas9-style tracing, optionally adding heritable/stochastic missing data and sequencing noise.
Args: dataset_id: Dataset handle containing a simulated tree. mutation_rate: Per-site mutation (cut) rate. number_of_cassettes: Number of independent cassettes. size_of_cassette: Number of characters per cassette. number_of_states: Number of possible indel states per character. add_missing: Apply cassiopeia.sim.missing_data after tracing. add_noise: Apply cassiopeia.sim.noise (miscalls) after tracing. extra_options: Extra kwargs forwarded to stochastic_tracing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| add_noise | No | ||
| dataset_id | Yes | ||
| add_missing | No | ||
| extra_options | No | ||
| mutation_rate | No | ||
| number_of_states | No | ||
| size_of_cassette | No | ||
| number_of_cassettes | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| n_obs | Yes | Number of observations (cells/leaves). | |
| trees | No | Keys in tdata.obst. | |
| layers | No | ||
| n_vars | Yes | Number of variables (e.g. genes). | |
| source | No | Origin path or generator. | |
| uns_keys | No | ||
| obsm_keys | No | ||
| dataset_id | Yes | ||
| obs_columns | No |