Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dnousome authored Jul 19, 2024
1 parent d6b9669 commit f38c65a
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module load ccbrpipeliner
```

## Usage
LOGAN supports either
LOGAN supports

### Input Files
LOGAN supports inputs of either
Expand All @@ -47,6 +47,18 @@ LOGAN supports inputs of either

`--bam_file_input` - A headerless tab delimited sheet that has the sample name, bam, and bam index (bai) file locations

### Genome
`--genome` - A flag to indicate which genome to run for alignment/variant calling/etc. Like `--genome hg38` to run the hg38 genome

`--genome hg19` and `--genome mm10` are also supported

#### hg38 has options for either
`--genome hg38` - Based off the GRCh38.d1.vd1.fa which is consistent with TCGA and other GDC processing pipelines

`--genome hg38_sf` - Based off the Homo_sapiens_assembly38.fasta which is derived from the Broad Institute/NCI Sequencing Facility
The biggest difference between the two is that GRCh38.d1.vd1.fa has fewer contigs (especially related to HLA regions), so reads should map to chr6 vs the HLA contig directly


### Operating Modes

#### 1. Paired Tumor/Normal Mode
Expand All @@ -64,8 +76,7 @@ No flags are required

Adding flags determines SNV (germline and/or somatic), SV, and/or CNV calling modes

`--vc`- Enables somatic SNV calling using mutect2, vardict, varscan, octopus, sage, MUSE (TN only), and lofreq (TN only)

`--vc`- Enables somatic SNV calling using mutect2, vardict, varscan, octopus, strelka (TN only), MUSE (TN only), and lofreq (TN only)

`--germline`- Enables germline using DV

Expand Down Expand Up @@ -110,8 +121,6 @@ logan run --mode local -profile ci_stub --genome hg38 --outdir out --fastq_input
logan run --mode slurm -profile biowulf,slurm --genome hg38 --outdir out --fastq_input "*R{1,2}.fastq.gz" --callers octopus,mutect2 --vc --sv --cnv
```

We currently support the hg38, hg19 (in progress), and mm10 genomes.




Expand Down

0 comments on commit f38c65a

Please sign in to comment.