dcouvin / CRISPRCasFinder

A Perl script allowing to identify CRISPR arrays and associated Cas proteins from DNA sequences
https://crisprcas.i2bc.paris-saclay.fr
GNU General Public License v3.0
82 stars 29 forks source link

CRISPRCasFinder

CRISPRCasFinder is an updated, improved, and integrated version of CRISPRFinder and CasFinder. CRISPR-Cas++

References/Citations

If you use this software, please cite:

Further information are available at: https://crisprcas.i2bc.paris-saclay.fr.

Quick Installation

Conda/Bioconda/Mamba

Note that you will first need to install conda/bioconda to run the following commands:

conda env create -f ccf.environment.yml -n crisprcasfinder
conda activate crisprcasfinder
mamba init
mamba activate
mamba install -c bioconda macsyfinder=2.1.2
macsydata install -u CASFinder==3.1.0

MacOS

./installer_MAC.sh

Ubuntu

bash installer_UBUNTU.sh
source ~/.profile

CentOS

Please first install conda if it is not already installed:

sudo yum -y update
sudo yum -y upgrade
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
bash Miniconda3-latest-Linux-x86_64.sh
export PATH=/path/to/miniconda3/bin/:$PATH
source ~/.bashrc
conda init
conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge

Now you can install CRISPRCasFinder as follows:

bash installer_CENTOS.sh
exit #this command could be needed if your command prompt changes
source ~/.bashrc

Fedora

sudo yum -y update
sudo yum -y upgrade
bash installer_FEDORA.sh
source ~/.bashrc

You can run the command 'perl CRISPRCasFinder.pl -v' to see if everything is OK. You may need to reinstall some Perl's modules (with command: sudo cpanm ...), for example: "sudo cpanm Date::Calc". The notification "Possible precedence issue with control flow operator ..." will not affect results of analysis. For further information, please see the documentation.

To run CRISPRCasFinder in the current directory with example sequence you can type:

perl CRISPRCasFinder.pl -in install_test/sequence.fasta -cas -keep

For further details, please see the documentation.

Documentation

A more complete User Manual is available at the following file : CRISPRCasFinder_Viewer_manual.pdf

Licence

GPL v3

Container

If you want to try CRISPRCasFinder without installing dependencies, The standalone version is also available as a singularity container (hosted on the Download page of the CRISPR-Cas++ portal):

To run the container

Former version of CRISPRCasFinder (v4.2.20)

After downloading the CrisprCasFinder.simg image from the CRISPR-Cas++ Download page, you can for example run the following command (sequence.fasta file must be replaced by your file):

singularity exec -B $PWD CrisprCasFinder.simg perl /usr/local/CRISPRCasFinder/CRISPRCasFinder.pl -so /usr/local/CRISPRCasFinder/sel392v2.so -cf /usr/local/CRISPRCasFinder/CasFinder-2.0.3 -drpt /usr/local/CRISPRCasFinder/supplementary_files/repeatDirection.tsv -rpts /usr/local/CRISPRCasFinder/supplementary_files/Repeat_List.csv -cas -def G -out RES21092020_2 -in sequence.fasta

Please visit the following link for more information about singularity containers: https://www.sylabs.io/docs/

Outline of the CRISPRCasFinder workflow