1. Installation#
Docker image is available at DockerHub.
1.1. Docker#
To use the docker command, type:
# Pull docker image
docker pull rnakato/churros
# Container login
docker run --rm -it rnakato/churros /bin/bash
# Execute a command
docker run -it --rm rnakato/churros <command>
1.2. Singularity#
Singularity is the alternative way to use the docker image. With this command you can build the singularity file (.sif) of Churros:
singularity build churros.sif docker://rnakato/churros
Instead, you can download the Churros singularity image from our Dropbox (We use singularity version 3.8.5).
Then you can run Churros with the command:
singularity exec churros.sif <command>
Singularity will automatically mount the current directory. If you want to access the files in the other directory, use the --bind
option, for instance:
singularity exec --bind /work churros.sif <command>
This command mounts the /work
directory.
1.3. Tools installed in Churros#
The latest version of Churros uses the following tools internally.
- ChIP-seq analysis
MACS2 v2.2.9.1
DROMPA+ v1.20.0
ROSE v0.1
STARE v1.0.4
ChromImpute v1.0.5
- Peak analysis
ChIPseeker v1.36.0
intervene v0.6.5
- Functional analysis
STITCHIT: link regulatory elements to genes
clusterProfiler v4.8.2
rGREAT v2.2.0
- Motif analysis
HOMER v4.11
TFBSTools v1.40.0
motifbreakR v2.14.2
- Adapter trimming
Cutadapt v4.7
TrimGalore v0.6.7
- Utility tools
SRAtoolkit v3.0.10