Skip to content

Commit aee1840

Browse files
authored
Clean up README by removing optional installation sections
Removed optional installation instructions for CRISPRon and sgDesigner.
1 parent aa80b16 commit aee1840

1 file changed

Lines changed: 0 additions & 58 deletions

File tree

README.md

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -246,64 +246,6 @@ You can confirm that CRISPRitz is correctly installed and functional by running:
246246
mamba run -n crispritz-crisprhawk crispritz.py
247247
```
248248

249-
If everything is working, the CRISPRitz help menu should appear, displaying available options and usage instructions.
250-
251-
#### 1.5.2 Install CRISPRon (Optional On-target Scoring)
252-
253-
[CRISPRon](https://github.com/RTH-tools/crispron) is a deep learning-based model for predicting SpCas9 guide RNA on-target efficiency. In CRISPR-HAWK, it can be used as an additional scoring module during `crisprhawk search`.
254-
255-
> 📝 **Note**: CRISPRon scoring is optional. If the dedicated environment is not installed, CRISPR-HAWK will skip CRISPRon scoring and continue running the rest of the pipeline.
256-
257-
**Installation Steps**:
258-
259-
From the root of the cloned CRISPR-HAWK repository, create the dedicated environment using the provided YAML file:
260-
261-
```bash
262-
conda create -y -c bioconda -c conda-forge --name crispron-crisprhawk --file crispron-crisprhawk.yml
263-
```
264-
265-
> 💬 **Why use a separate environment?**
266-
<br>This avoids dependencies conflicts with the main CRISPR-HAWK installation and ensures better reproducibility of the CRISPRon scoring module.
267-
268-
> 📝 **Note**: Environment creation may take several minutes depending on your system and package solver.
269-
270-
**Test your installation**
271-
272-
You can verify that the environment was created successfully by running:
273-
274-
```bash
275-
conda run -n crispron-crisprhawk python -c "print('CRISPRon environment correctly installed')"
276-
```
277-
278-
If the command completes successfully, CRISPR-HAWK will be able to use the CRISPRon scoring module during guide search.
279-
280-
#### 1.5.3 Install sgDesigner (Optional On-target Scoring)
281-
282-
[sgDesigner](https://github.com/wang-lab/sgDesigner) is a machine learning-based tool for predicting SpCas9 guide RNAs efficiency. In CRISPR-HAWK, it can be used as an optional scoring module during `crisprhawk search` to complement the built-in guide prioritization framework.
283-
284-
> 📝 **Note**: sgDesigner scoring is optional. If the dedicated environment is not installed, CRISPR-HAWK will skip sgDesigner scoring and continue running the rest of the pipeline.
285-
286-
**Installation Steps**:
287-
288-
Create a dedicated environment for sgDesigner:
289-
290-
```bash
291-
conda create -y --name sgdesigner-crisprhawk python=3.7.0 numpy=1.15.2 scipy=1.1.0 scikit-learn=0.20.0 xgboost=0.80 joblib=0.13.2
292-
```
293-
294-
> 💬 **Why use a separate environment?**
295-
<br>This prevents potential dependency conflicts with the main CRISPR-HAWK environment and preserves compatibility with the sgDesigner software requirements.
296-
297-
**Test your installation**
298-
299-
You can confirm that the environment is available by running:
300-
301-
```bash
302-
conda run -n sgdesigner-crisprhawk python -c "print('sgDesigner environment correctly installed')"
303-
```
304-
305-
If the command completes successfully, CRISPR-HAWK will be able to include sgDesigner scoring during guide search.
306-
307249
## 2 Usage
308250

309251
CRISPR-HAWK provides multiple functionalities designed to support variant- and haplotype-aware CRISPR guide design, gRNA efficiency evaluation, and integration with downstream analysis pipelines. Each command serves a distinct role in the workflow.

0 commit comments

Comments
 (0)