Code Monkey home page Code Monkey logo

score's Introduction

License: GPLv3

SCORE

Smart Consensus Of RNA Expression pipelines

SCORE Workflow

Table of Contents

  1. Setup
  2. Usage
  3. FAQ
  4. License

1. Setup

1.1 Manual Setup

Download and extract the latest stable release of SCORE from here.

Dependencies:

Optional:

Please ensure that the latest versions of the dependencies listed above are installed on your system.

Then run the installation script:

./libraries/miscellaneous/install.sh

1.2 Docker Image

Alternatively, SCORE can be installed via Docker.

Dependencies:

Use the following command to install the SCORE docker container:

docker pull eppinglen/score:v1.0.1

Download and edit the SCORE config file:

wget https://github.com/SiWolf/SCORE/blob/master/config.yaml

And run SCORE for your data:

sudo docker run --rm -it -v <your config.yaml>:/SCORE/config.yaml  -v <directory with reads and metadata>:/SCORE/raw -v <references genomes directory>:/SCORE/references -v <output directory>:/SCORE/deg -w /SCORE eppinglen/score:v1.0.1 /bin/bash run-SCORE.sh <amount_of_threads> <PE/SE>

Or for the test data:

sudo docker run --rm -it -v <output directory>:/SCORE/deg -w /SCORE eppinglen/score:v1.0.1 /bin/bash run-SCORE-test.sh <amount_of_threads> <study_number>

2. Usage

Requirements:

  • Adapter-Trimmed RNA-Seq Reads (.fastq or .fastq.gz)
  • Reference Annotation File (.gff)
  • Reference Genome (.fasta)

Place input reads into the raw/ directory and reference files into references/.

Set parameters in the following files:

And run SCORE:

./run-SCORE.sh <amount_of_threads> <PE/SE>

For more details please refer to our wiki.

3. Test data

The current version of SCORE includes configuration files for downloading and analyzing a selection of published data sets:

  1. Houser, John R., et al. "Controlled measurement and comparative analysis of cellular components in E. coli reveals broad regulatory changes in response to glucose starvation." PLoS computational biology 11.8 (2015).
  2. Peyrusson, Frédéric, et al. "Intracellular Staphylococcus aureus persisters upon antibiotic exposure." Nature Communications 11.1 (2020): 1-14.
  3. Rodman, Nyah, et al. "Human pleural fluid elicits pyruvate and phenylalanine metabolism in Acinetobacter baumannii to enhance cytotoxicity and immune evasion." Frontiers in microbiology 10 (2019): 1581.

The following command can be used to download the data and run SCORE:

./run-SCORE-test.sh <amount_of_threads> <study_number>

Downloads provided by SRA-Explorer.

4. FAQ

How can I compute the total runtime of my analysis?

Using the executable script mentioned above will automatically output the runtime at successful termination. Sequanix will not provide additional runtime information.

I can't edit the config file and I can't use Sequanix, is there another way of setting parameters?

Yes, it is possible to either edit the Snakefile itself (not recommended) or using the command "snakemake -s "SCORE_PE.snk" --config {parameter}={value}" to set a specified {parameter} to a {value}.

Snakemake is unable to activate the included environments - what can I do?

You are possibly using an incompatible version of Conda (> 4.5.13). Conda has underwent several syntax updates since August 2019, resulting in incompatibility with certain Snakemake versions. Following the advice mentioned here, please install Conda version 4.5.13 and modify your .bashrc in order to ensure compability with Snakemake.

# Add the following line to your .bashrc file
# Restart your terminal afterwards
export PATH="/full/path/to/miniconda3/bin:$PATH"

# Install the required conda version
conda install -n base conda=4.5.13

Snakemake outputs an error stating that not all output, log and benchmarking files contain the same wildcards? What does this mean?

Starting with Snakemake version 5 and above, the syntax for dynamic rules has been updated. Please use Snakemake version 4.6.0 for running SCORE.

How do I cite SCORE?

Please cite the following:

Wolf, Silver A., et al. "SCORE: Smart Consensus Of RNA Expression-a consensus tool for detecting differentially expressed genes in bacteria." Bioinformatics (2020). https://doi.org/10.1093/bioinformatics/btaa681.

5. License

This project is licensed under the GPLv3 License. See the LICENSE file for more details.

score's People

Contributors

andreott avatar eppinglen avatar siwolf avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

score's Issues

Conda not able to install packages labeled 'broken'

Thanks for the nice software!

When installing the dependencies through Snakemake + Conda, some YAML files refer to packages labeled 'broken'. To the best of my knowledge, these cannot be installed through Snakemake (however manually you can set e.g. -c bioconda/labels/broken to include them, but I haven't seen an option with Snakemake to do this).

AFAIK this only concerns score_deg_environment.yml. The error message is:

Creating conda environment libraries/env/score_deg_environment.yml...
Downloading remote packages.
CreateCondaEnvironmentException:
Could not create conda environment from /project/vdputten/Kees/RM/SCORE-1.0.1/libraries/env/score_deg_environment.yml:
Collecting package metadata (repodata.json): ...working... done
Solving environment: ...working... failed

ResolvePackageNotFound:
  - libgfortran-ng==7.5.0=hdf63c60_6
  - gxx_impl_linux-64==7.5.0=hdf63c60_6
  - gfortran_impl_linux-64==7.5.0=hdf63c60_6
  - gcc_impl_linux-64==7.5.0=hd420e75_6

Replacing the tags with tags from the same version but a different build might work

error running

Hi @SiWolf

I am trying to run this pipeline but unfortunately I get an error. Any idea how to solve it? I have already added my fasta and gff files to the reference folder and I have updated the metadata file. But i keep getting the same error.

`(score) sam@bioinf-pc:~/Downloads/SCORE$ bash run-SCORE.sh 2 PE
rm: cannot remove '.gz': No such file or directory
rm: cannot remove '
.idx': No such file or directory
rm: cannot remove 'kallisto/sample*': No such file or directory
rm: cannot remove '.rda': No such file or directory
rm: cannot remove '
.txt': No such file or directory
rm: cannot remove 'consensus*': No such file or directory
rm: cannot remove 'deg*': No such file or directory
rm: cannot remove 'diffexpr*': No such file or directory
rm: cannot remove 'filtered*': No such file or directory
rm: cannot remove 'genes*': No such file or directory
rm: cannot remove 'hmmer*': No such file or directory
rm: cannot remove 'pathway*': No such file or directory
rm: cannot remove 'proteins*': No such file or directory
rm: cannot remove 'transcript*': No such file or directory
rm: cannot remove 'summary*': No such file or directory
rm: cannot remove 'benchmarking*': No such file or directory
rm: cannot remove 'log.txt': No such file or directory
rm: cannot remove 'references/.tmp': No such file or directory
rm: cannot remove '
': No such file or directory
rm: cannot remove '': No such file or directory
rm: cannot remove '
.sam': No such file or directory
rm: cannot remove '': No such file or directory
rm: cannot remove '
': No such file or directory
FileNotFoundError in line 203 of /home/sam/Downloads/SCORE/SCORE_PE.snk:
[Errno 2] No such file or directory: 'references/027-annot.gff'
File "/home/sam/Downloads/SCORE/SCORE_PE.snk", line 218, in
File "/home/sam/Downloads/SCORE/SCORE_PE.snk", line 203, in verfify_id_combination
FileNotFoundError in line 203 of /home/sam/Downloads/SCORE/SCORE_PE.snk:
[Errno 2] No such file or directory: 'references/027-annot.gff'
File "/home/sam/Downloads/SCORE/SCORE_PE.snk", line 218, in
File "/home/sam/Downloads/SCORE/SCORE_PE.snk", line 203, in verfify_id_combination

real 0m0,157s
user 0m0,133s
sys 0m0,025s
`

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.