SCYN: Single cell CNV profiling method using dynamic programming
SCYN: Single cell CNV profiling method using dynamic programming
Pre-requirements
- python3
- numpy>=1.16.1
- pandas>=0.23.4,<0.24
- tasklogger>=0.4.0
- scipy>=1.3.0
- pysam>=0.15.3
- SCOPE
install requirements
pip install -r requirements.txt
To install R package SCOPE, please refer to the README of SCOPE. SCYN integrates the SCOPE to get the cell-by-bin reads depth matrix and perform the normalization. SCYN mainly focuses on finding the optimal CNV segmentation profiling using dynamic programming.
Installation
Installation with pip
To install with pip, run the following from a terminal:
pip install scyn
Installation from Github
To clone the repository and install manually, run the following from a terminal:
git clone https://github.com/xikanfeng2/SCYN.git
cd SCYN
python setup.py install
Usage
Quick start
The following code runs SCYN.
In command line:
usage: python run-scyn.py [-h] [options] -i input_bams_dir
SCYN: Single cell CNV profiling method using dynamic programming efficiently
and effectively
required arguments:
-i, --indir <str> the input bams directory (default: None)
optional arguments:
-o, --outdir <str> the output directory (default: ./)
--seq <str> the reads type: single-end or paired-end. (default:
single-end)
--bin_len <int> the bin length, default is 500K. (default: 500)
--ref <str> the reference genome version: hg19 or hg38.
(default: hg19)
--reg <str> the regular expression to match all BAM files in
your input directory. For example, ".bam" will match all
BAM files ended with '.bam'. (default: *.bam)
--mapq <int> the mapping quality cutoff when calculating the
reads coverage. (default: 40)
--verbose <int> If > 0, print log messages. (default: 1)
-h, --help
In Python:
import scyn
# create SCYN object
scyn_operator = scyn.SCYN()
# call cnv
# bam_dir is the input bam directory and output_dir is the output directory
scyn_operator.call(bam_dir, output_dir)
# store cnv matrix to a csv file
scyn_operator.cnv.to_csv('your file name')
For 10X merged BAM(One bam file), SCYN provides the function to split merged bam to cell bams based on the barcodes.
import scyn
scyn.demultiplex_10X_bam(info_file, bam_file, out_dir)
This function demultiplexs 10X merged bam file according to barcode Parameters:
- info_file : the sample summary info file. Please refer to the 10X websites breast_tissue_A_2k_per_cell_summary_metrics.csv
- bam_file : the merged bam file path.
- out_dir : output directory. The splited bams will be saved in this directory, named as
cell-barcode.bam. cell-barcode is the barcode of each cell.
SCYN attributes
scyn_operator = scyn.SCYN()
scyn_operator.cnvis the copy number variants matrix.scyn_operator.segmentsis the segments for each chromosome.scyn_operator.meta_infois the meta information of cells, include gini and ploidy.
SCYN Output Format
The output of SCYN consits of two cnv files and one meta file.
-
cnv.csv: with cell as row and bin as column. This file can be used as the input of Oviz-SingleCell CNV analysis. -
cnv_T.csv: with bin as column and cell as row, it is the transpose matrix ofcnv.csv. This file can be parse by popular R packages likeExpressionSetfor downstream analysis. -
segments.csvis the cnv segments information for each chromosome. -
meta.csv: with cell as row, and meta information as column. The default meta information is:c_gini: stores the gini coeficient of each cell.c_ploidy: stores the mean ploidy of each cell, it is calculated fromcnv.csv(not the one SCOPE provide).
User can manually add extra cell meta information like 'cell_type', 'cluster', or 'group' for downstream analysis. Prefix
chere denotes numeric continuous value. The absence of prefixcdenotes category meta information like 'group' or 'cluster'.
Parameters
SCYN(seq='single-end', bin_len=500, ref='hg19', reg='*.bam', mapq=40, verbose=1)
Parameters
-
seq : string, optional, default: single-end The reads type: single-end or paired-end
-
bin_len : int, optional, default: 500 The bin length, default is 500K
-
ref : string, optional, default: hg19 The reference genome version: hg19 or hg38
-
reg : string, optional, default: .bam The regular expression to match all BAM files in your input directory. For example, ".bam" will match all BAM files ended with '.bam'
-
mapq : int, optional, default: 40 The mapping quality cutoff when calculating the reads coverage
-
verbose :
intorboolean, optional, default: 1If
Trueor> 0, print status messages
Cite us
Help
If you have any questions or require assistance using SCYN, please contact us with xikanfeng2@gmail.com.
Metadata
Release files for SCYN 1.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| SCYN-1.0.6.tar.gz | 8.7 kB | Without provenance | Details for SCYN-1.0.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| SCYN-1.0.6-py3-none-any.whl | Python 3 | none | any | Details for SCYN-1.0.6-py3-none-any.whl |
Total release size: 18.2 kB
Release files / SCYN-1.0.6.tar.gz
| Download URL | SCYN-1.0.6.tar.gz |
|---|---|
| Size | 8.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
988edcdaeb183b1367d89e7735852ffd6e95c94a39d4f2a234bc8cfadaee55b9
|
|
BLAKE2b-256 checksum How to use checksums |
2668b35703b7e758ea9dcd874af36e2923103490871152160120fce26b524ad7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.0
|
Release files / SCYN-1.0.6-py3-none-any.whl
| Download URL | SCYN-1.0.6-py3-none-any.whl |
|---|---|
| Size | 9.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1f8bea0b521c6ad2ea11126cce3b643f6db8c528022e4aee52d0cc24384490fa
|
|
BLAKE2b-256 checksum How to use checksums |
dc1f1ad8f038e9a9d46e1287c3b6b80ecb3e40c5f23ddf8e4dabd79f3c11ef14
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.0
|
Security for SCYN 1.0.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.