Skip to main content

An inference tool for tumour subclonal composition

Project description

FastClone

FastClone is a fast algorithm to infer tumour heterogeneity. Given somatic mutation frequencies and copy number data, FastClone infers subclonal composition and phylogeny. The algorithm won the first place in DREAM Somatic Mutation Calling -- Heterogeneity Challenge in 2016.

Installation

FastClone needs Python 3.5 or later version. It needs logbook, python-fire, scikit-learn, and pandas. To install the package using Pip,

git clone https://github.com/GuanLab/FastClone_GuanLab.git
pip install FastClone_GuanLab/

(Please make sure you have the slash at the end, which forces pip to install from local directory, otherwise it will run into error)

You also can directly pip install FastClone with the command below.

pip install fastclone-guanlab

Usage

FastClone accepts either MuTect VCF + Battenberg format (specified in the DREAM SMC-Het Challenge) or PyClone format.

The general format of the command line:

fastclone load-[FILE_FORMAT] prop [FILE_NAME] [TUMOR_PURITY] solve [OUTPUT_PATHWAY]

(If purity is unavailable, input "None" at the position of [TUMOUR__PURITY], and FastClone will infer purity automatically)

A pseudo example to load samples and infer (t1.tsv is included in this repository):

fastclone load-pyclone prop t1.tsv 0.8 solve ./fastclone_result

(Please make sure t1.tsv is under your current directory. Note this pseudo example only has one clone with a purity ~0.15)

Run fastclone for more help information.

If MuTect VCF and PyClone samples are provided, note that MuTect mutations are labelled as 'Chromosome:Coordinate:AltBase', such as 'Y:15989697:G'. Make sure PyClone ID uses the same ID.

Separately, subclone.py will infer purity (whether a starter value is given or not), and subclone identification and assignment; phylogeny.py will infer phylogeny.

Output

1.subclones.csv gives proportion of each clone in a tumor sample.

2.scores.csv gives SNPs assignment. Each column corresponding to a clone, and the entries in each column indicates how likely the SNP is assigned to the clone.

3.phylogeny.png shows the tree structure of clones.

(We named clones with numeric values, which start from 0, and the names are consistent within all output files)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastclone-guanlab-1.0.4.1.tar.gz (9.0 kB view hashes)

Uploaded Source

Built Distribution

fastclone_guanlab-1.0.4.1-py3-none-any.whl (22.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page