Skip to content

Desperate-Dan/maskara

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

maskara

A tool to create a coverage mask from BAM files to apply during consensus generation, in particular creates a tsv than can be used with bcftools consensus.

Installation

git clone https://github.com/Desperate-Dan/maskara.git && cd maskara
pip install .

You can now install maskara directly from pip!

pip install maskara

Usage

usage: maskara [-h] [-d DEPTH] [-r REF_NAME] [-o OUTPUT_NAME] input_file

Creates a coverage mask to apply to your lovely consensus fasta.

positional arguments:
  input_file            Path to the BAM file you want to create a mask for

optional arguments:
  -h, --help            show this help message and exit

Optional:
  -d DEPTH, --depth DEPTH
                        If coverage is below this it will be masked. Default = 20
  -r REF_NAME, --ref-name REF_NAME
                        Name of ref the bam files were aligned to. Default = "MN908947.3"
  -o OUTPUT_NAME, --output-name OUTPUT_NAME
                        Prefix for the output. Default = "depth_mask"
  -m FASTA_TO_MASK, --mask FASTA_TO_MASK
                        Mask a consensus sequence with your newly produced mask
  -i, --inverse         Return bed file of positions EQUAL OR ABOVE the chosen depth

About

A tool to create a coverage mask from BAM files to apply during consensus generation.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages