Browse Source

update README.md

master
YaqingLiu 5 years ago
parent
commit
c247ae353a
1 changed files with 18 additions and 56 deletions
  1. +18
    -56
      README.md

+ 18
- 56
README.md View File

#### Usage
### Choppy APP Usage
$ open-choppy-env $ open-choppy-env
$ choppy install YaqingLiu/bamdst $ choppy install YaqingLiu/bamdst
$ choppy batch YaqingLiu/bamdst-latest samples.csv -p project_name $ choppy batch YaqingLiu/bamdst-latest samples.csv -p project_name


#### samples.csv
### samples.csv
sample_id,sample,bam,bed sample_id,sample,bam,bed




# bamdst -- a BAM Depth Stat Tool
### bamdst -- a BAM Depth Stat Tool


Bamdst is a lightweight tool to stat the depth coverage of target regions of bam file(s). Bamdst is a lightweight tool to stat the depth coverage of target regions of bam file(s).




must be specified in the first place. must be specified in the first place.


## USAGE
#### USAGE


Normal: Normal:




samtools view in1.bam -u | bamdst -p x.bed -o ./ - samtools view in1.bam -u | bamdst -p x.bed -o ./ -


## PARAMETERS
#### PARAMETERS


-o / --outdir [dir] -o / --outdir [dir]




the probe or captured target region file, these regions will be merged first [mandatory] the probe or captured target region file, these regions will be merged first [mandatory]


## OPTIONAL PARAMETERS

-f / --flank [num]

if you want calculate the coverage of flank region, set this value, default is 200

--maxdepth [num]

for some projects, the depths of sepcial region are very high, if you don't want show

these unnormal depths in cumulation distrbution file, set the cutoff value to filter them.

default is 0 (no filter).

--cutoffdepth [num]

for some projects, people care about the coverage of specified depth, like 10000x etc.

bamdst just calculate the coverage of 0x, 4x, 10x, 30x, 100x, so you can set this value

to show the specified coverage in the coverage.report file. Default is 0.

--isize [num]

for bad mapped paired reads, the inferred insert size is very huge. So set a cutoff

value for reasonal visual purpose. Default is 2000.

--uncover [num]

set this cutoff value for calculate the bad covered region. Default is <5.

--use_rmdup (an invalid parament since v1.0.0 )

Use rmdup depth instead of cover depth to calculate the coverage of target regions and

so on.

## OUTPUT FILES
#### OUTPUT FILES


Seven files will be created in the output direction. There are: Seven files will be created in the output direction. There are:


-**coverage.report** -**coverage.report**


-**cumu.plot**
-**depth_distribution.plot**


-**insert.plot**
-**insertsize.plot**


-**chromosome.report**
-**chromosomes.report**


-**region.tsv.gz** -**region.tsv.gz**




-**uncover.bed** -**uncover.bed**


## DETAILS of each file
#### DETAILS of each file


**coverage.report** **coverage.report**




Here is the full details of each entry. Here is the full details of each entry.


[Total] Raw Reads (All reads) // All reads in the bam file(s).
[Total] QC Fail reads // Reads number failed QC, this flag is marked by other software,like bwa. See flag in the bam structure.
[Total] Raw Data(Mb) // Total reads data in the bam file(s).
[Total] Paired Reads // Paired reads numbers.
[Total] Raw Reads (All reads) // All reads in the bam file(s).
[Total] QC Fail reads // Reads number failed QC, this flag is marked by other software,like bwa. See flag in the bam structure.
[Total] Raw Data(Mb) // Total reads data in the bam file(s).
[Total] Paired Reads // Paired reads numbers.
[Total] Mapped Reads // Mapped reads numbers. [Total] Mapped Reads // Mapped reads numbers.
[Total] Fraction of Mapped Reads // Ratio of mapped reads against raw reads. [Total] Fraction of Mapped Reads // Ratio of mapped reads against raw reads.
[Total] Mapped Data(Mb) // Mapped data in the bam file(s). [Total] Mapped Data(Mb) // Mapped data in the bam file(s).
[flank] Coverage (>=30x) // Ratio of flank bases with depth greater than or equal to 30x. [flank] Coverage (>=30x) // Ratio of flank bases with depth greater than or equal to 30x.




**cumu.plot**
**depth_distribution.plot**


Depth distrbution for plot. Depth distrbution for plot.


**insert.plot**
**insertsize.plot**


Inferred insert size distribution for plot. Inferred insert size distribution for plot.


**chromosome.report**
**chromosomes.report**


Depth and coverage information of each chromosome. Depth and coverage information of each chromosome.




uncover by parameter "--uncover" uncover by parameter "--uncover"


# Known bugs
#### Known bugs


For a large region, like whole genome region, bamdst may go crash with a segmental fault. I have noticed issues like this, and this bug can be tolerated by split a large region into several small pieces. However, this bug may not be fixed until next major update. For a large region, like whole genome region, bamdst may go crash with a segmental fault. I have noticed issues like this, and this bug can be tolerated by split a large region into several small pieces. However, this bug may not be fixed until next major update.

Loading…
Cancel
Save