Configuring DICAST

Before running DICAST, please take some time to configure it for your first run.

DICAST is best run with the GUI, which automates the configuration of scripts/snakemake/snakemake_config.yaml, scripts/config.sh & scripts/asevent_config.sh, for a quick run of DICAST without simulated data, on your experiments.

DICAST can be run via CLI, however, this feature is currently in development.

If you’d like to modify the Simulated dataset, please modify scripts/ASimulatoR_config.R (See ASimulatoR Parameters)

If you’d like to run DICAST with just one tool via docker, then the files you need to modify are: scripts/config.sh, scripts/asevent_config.sh

It’s recommended to take a closer look at the config files on disk before your first run.

The following files are all the configuration files found in DICAST:
scripts/snakemake/snakemake_config.yaml,
scripts/ASimulatoR_config.R,
scripts/config.sh &
scripts/asevent_config.sh.

Read the full reference here

Most frequent changes to configurations:

Note

The following explanations assume that you use our directory structure as described in Directory Structure.

1. scripts/snakemake/snakemake_config.yaml

The following are the snakemake parameters that you’re most likely to change for a CLI run:.

Possible_overwrite_acknowledge:
do: false
change to true. This is set to false after every run to prevent overwriting of output files
Mapping_tools:
What_tools_to_run: ‘<insert name of mapping tools to run, separated by spaces>’
pick one of the following bbmap contextmap crac dart gsnap hisat mapsplice minimap segemehl star subjunc
Example: to some two tools: ‘minimap star’
Example: to run all tools: ‘bbmap contextmap crac dart gsnap hisat mapsplice minimap segemehl star subjunc’
Example: to run one tool: ‘star’
Alternative_splicing_detection_tools:
What_tools_to_run: ‘<insert name of Alternative Splicing tools to run, separated by spaces>’
pick one of the following asgal aspli eventpointer irfinder majiq sgseq spladder whippet
Example: to run all tools: ‘asgal aspli eventpointer irfinder majiq sgseq spladder whippet’
Example: to some two tools: ‘eventpointer whippet’
Example: to run one tool: ‘whippet’

2. scripts/config.sh

The following are basic parameters that you are most likely to change on the GUI and in the file scipts/config.sh.

Warning

Since these files are bash scripts, it is important to mind the syntax rules. E.g., there can’t be a whitespace before and after “=”.

Basic Parameters

ncores
if you want to use more cores for each tool within snakemake. (not the same as total cores available for snakemake -j 2)

Input Parameters

asimulator_gtf
the genome gtf annotation that you use to simulate the data. Default: ‘Homo_sapiens.GRCh38.104.gtf’.
fastaname
the genome reference file. Default: ‘Homo_sapiens.GRCh38.dna.primary_assembly.fa’.
gtfname
the genome gtf annotation that you use for mapping and alternative splicing analysis. If you’re using ASimulatoR, leave this as ASimulatoR.gtf.
gffname
the genome gff3 annotation that you use for mapping and alternative splicing analysis. If you’re using ASimulatoR, leave this as ASimulatoR.gff3.

The reference genome, annotation file and gff3 files could be downloaded from Ensembl.