as_brainmets_v2
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.8%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: uretaj
- License: other
- Language: Python
- Default Branch: master
- Size: 19 MB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
ampliconsuitebrainmets
The original code and instructions are from https://github.com/AmpliconSuite/AmpliconSuite-pipeline . It has been modified to generate the seed intervals from the FACETS calls, which are then passed to Amplicon Architect.
Installation
Obtain the data repository containing the AmpliconSuite-pipeline image and GRCh37 annotations :
- Download the data repo: https://datasets.genepattern.org/?prefix=data/modulesupportfiles/AmpliconArchitect
- Extract the tar file
bash tar zxf GRCh38.tar.gz.gz - Download the singularity image
bash singularity pull library://jluebeck/ampliconsuite-pipeline/ampliconsuite-pipeline - Put both inside a folder named data_repo
Obtain the execution script
bash git clone https://github.com/uretaj/as_brainmets_v2/.gitLicense for Mosek optimization tool:
- Obtain license file
mosek.lic(https://www.mosek.com/products/academic-licenses/). The license is free for academic use. - Place the file in
$HOME/mosek/(i.e, themosek/folder that now exists in your home directory). If you are not able to place the license in the default location, you can set a custom location by exporting the bash variable
MOSEKLM_LICENSE_FILE=/custom/path/.bash export MOSEKLM_LICENSE_FILE="/path/to/mosek.lic"An example command might look like:
- Obtain license file
as_brainmets_v2/singularity/run_paa_singularity.py -o path/to/output_dir/sample --bam sample.bam --scna_file sample.txt --data_repo path/to/data_repo
Below is a sample Slurm file: ```bash
!/bin/bash
SBATCH --job-name=circdna.slurm
SBATCH --ntasks=1
SBATCH -t 48:00:00
SBATCH --cpus-per-task=1
SBATCH --mail-type=ALL
SBATCH --output=%x.%a.%j.out # STDOUT
SBATCH --error=%x.%a.%j.err # STDERR
SBATCH --array=1-40
SBATCH --mem-per-cpu=100G
module load singularity/3.8.2 export MOSEKLMLICENSEFILE="mosek/mosek.lic" echo "ARRAY ID: ${SLURMARRAYTASKID}" filename=$(head -n ${SLURMARRAYTASKID} hlfalistallcountries.csv | tail -1) filename=${filename%$'\r'} IFS=',' read -ra arr <<< "$filename" sample=${arr[0]} cnv=${arr[1]} echo "SAMPLE ${sample}" echo "FILENAME ${cnv}" pathf="BAM/${sample}.mapped.bam" cnvpath="SubclonalSCNAwithAvgCN/${cnv} asbrainmetsv2/singularity/runpaasingularity.py -o AARESULT/${sample} -t 1 --bam ${pathf} --scnafile ${cnvpath} --datarepo path/data_repo ``` Here's an example of how to submit a job arrray to run multiple samples (i.e. execute the script for 40 samples but only run 5 samples at a time)
bash
sbatch --array=1-40%5 amplicon_suite.slurm
Command line arguments to AmpliconSuite-pipeline
Required
-o {outdir}: Directory where results will be stored. Include the sample name to avoid conflicts.--data_repo {repodir}: Directory where the singularity image file and required annotations for GRCh38 are stored.-t: Number of threads but it's not really used so just set it to 1.
Input files:
--bam {sample.bam}Coordinate-sorted bam--scna_file {scna.txt}Supply the FACETS calls of the sample to generate the seed intervals to be passed to Amplicon Architect.
Owner
- Name: Jennifer Ureta
- Login: uretaj
- Kind: user
- Repositories: 1
- Profile: https://github.com/uretaj
Citation (CITATIONS.md)
### Please cite the following tools which are part of AmpliconSuite-pipeline in your work, where applicable - AmpliconSuite-pipeline & AmpliconClassifier - https://www.biorxiv.org/content/10.1101/2024.05.06.592768v1 - AmpliconArchitect - https://pubmed.ncbi.nlm.nih.gov/30674876/ - BWA MEM - https://arxiv.org/abs/1303.3997 - CNVkit - https://pubmed.ncbi.nlm.nih.gov/27100738/ - SAMtools - https://pubmed.ncbi.nlm.nih.gov/19505943/
GitHub Events
Total
- Watch event: 1
- Public event: 1
- Push event: 2
Last Year
- Watch event: 1
- Public event: 1
- Push event: 2
Dependencies
- ubuntu 20.04 build
- Cython ==0.29.28
- Flask >=2.2.5
- biopython ==1.79
- cnvkit ==0.9.10
- future ==0.18.3
- intervaltree ==3.1.0
- matplotlib ==3.5.1
- mosek ==10.0.38
- numpy >=1.22.2
- pandas ==1.4.1
- pyfaidx ==0.6.4
- pysam ==0.18.0
- reportlab ==3.6.8
- scipy ==1.7.3
- Cython ==0.29.28
- Flask >=2.2.5
- biopython ==1.79
- cnvkit ==0.9.10
- future ==0.18.3
- intervaltree ==3.1.0
- matplotlib ==3.5.1
- mosek ==10.0.38
- networkx ==3.1
- numpy ==1.22.2
- pandas ==1.4.1
- pyfaidx ==0.6.4
- pysam ==0.18.0
- reportlab ==3.6.8
- scipy ==1.7.3