breaks-software / Candida-CRISPR-Target-Notebook

This Google Colab Notebook is intended to be used to speed the processing and identification of target gRNA sequences for introduction to Candida species via CRISPR techniques.
MIT License
0 stars 0 forks source link

Candida-CRISPR-Target-Notebook

If you want to speed up processing and identification of target gRNA sequences for introduction to Candida species via CRISPR techniques, this Jupyter notebook can help. After the user fills in a sequence of forms and selects Run all, the code will;

  1. pull the full sequence for your target species from the Candida Genome Database
  2. automatically fill in the form on the Eukaryotic Pathogen CRISPR gRNA Design Tool (EuPaGDT), submit the request, and collect the potential gRNA sequence targets
  3. automatically fill in the form on the RNAFold Web Server for all of the gRNA sequence targets, submits the request, then collect the results,
  4. and finally, generate a table that includes the key columns from both sets of results, and download both CSV and HTML versions of the results table.

The nice thing about this is that the notebook does all of the waiting for the different servers for you. If, for example, the EuPaGDT generates a lot of results that need to be submitted to the RNA Fold Server, you don't have to manually process them one by one. The notebook does that for you, consolidating the information from both servers into one table. And if you get the process started then walk away only to return after Google Colab has disconnected you, the notebook as already downloaded the results to your local Downloads directory.

Requirements

This Jupyter Notebook uses features that are only available in Google Colaboratory. For example, we can easily hide code to avoid distraction by using forms. For this reason, you are encouraged to use the notebook from there.

Usage

[We assume that you are familiar with using Jupyter Notebooks.]

Steps in sequence

The first few times you use this, it is best to step through each of the steps in the notebook in sequence. If there are fields to fill in, ensure that the default values are what you need, or change them to meet your needs before you click on the Run button.

All at once

After you are familiar with the steps, and the various options you have at each point, you can easily fill in the fields for all of the forms in the notebook, then select to "Run all".

Citations

If you use this notebook as part of work that is to be published, please add the following citations for the underlying tools to your published work:

License

The software in this project is licensed under the MIT License. Refer to the LICENSE file. The services that this software uses may be protected by their own copyright. Refer to the web sites linked above for their respective copyright or license.