From 7036724904889354d302ce2d17c3b6db2f202701 Mon Sep 17 00:00:00 2001
From: Arslan Tariq <arslan.tariq@hhu.de>
Date: Tue, 6 Aug 2024 09:53:15 +0000
Subject: [PATCH] Update README.md

---
 README.md | 133 +++++++++++++++++++++++-------------------------------
 1 file changed, 56 insertions(+), 77 deletions(-)

diff --git a/README.md b/README.md
index 40a3a70..81631cf 100644
--- a/README.md
+++ b/README.md
@@ -1,93 +1,72 @@
 # PoreC_analysis
+This repository contains the PoreC data analysis pipeline, encompassing both the pre-processing of PoreC data and the scaffolding of genomic sequences using PoreC data. This pipline is inspired by [wf-pore-c](https://github.com/epi2me-labs/wf-pore-c) and [HapHiC](https://github.com/zengxiaofei/HapHiC).
 
-
+## Installation
+Make a new conda enviornment and install dependencies:
+```
+conda env create -f environment.yaml
+conda activate PoreC-env
+conda install bioconda::minimap2
+conda install bioconda::samtools
+conda install bioconda::yahs
+```
+Additionally, this pipeline requires two scripts, [rename_reads_for_bam.py](https://github.com/zengxiaofei/HapHiC/files/13701199/rename_reads_for_bam.py.gz) and [filter_bam.py](https://github.com/zengxiaofei/HapHiC/blob/main/utils/filter_bam.py) which are borrowed from [HapHiC](https://github.com/zengxiaofei/HapHiC). These scripts are availble in the [scripts](https://git.nfdi4plants.org/usadellab/porec_analysis/-/tree/main/scripts?ref_type=heads) directory.
 
 ## Getting started
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
-
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-
+### 1- Make index of contig files
 ```
-cd existing_repo
-git remote add origin https://git.nfdi4plants.org/usadellab/porec_analysis.git
-git branch -M main
-git push -uf origin main
+samtools faidx genome.contig.fasta
 ```
 
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://git.nfdi4plants.org/usadellab/porec_analysis/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+### 2- Digest chimeric reads
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+```
+ENZYME="DpnII"
+THREADS=56
+pore-c-py digest PoreC.reads.fq.gz  ${ENZYME} --threads ${THREADS} --max_monomers 250 > Digest.bam
+```
+Here, you can adjust the enzyme and threads settings based on the enzyme used in the PoreC library preparation and the available computational resources.
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+### 3- Getting digest reads
+```
+samtools fastq -@ 8 -T '*' Digest.bam > Digest.tag.fastq
+```
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+### 4- Map to the genome
+Now map these monomers to the genome.
+```
+minimap2 -ay -x map-ont -t ${THREADS} genome.contig.fasta Digest.tag.fastq >Digest.map.sam
+```
+### 5- Annotate links
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+```
+SAMPLE="genome"
+args="--chromunity --chromunity_merge_distance -1 --paired_end --filter_pairs --paired_end_minimum_distance 100 --paired_end_maximum_distance 200"
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+pore-c-py annotate Digest.map.sam ${SAMPLE}_annotated --monomers --threads ${THREADS} --stdout --summary ${args} |\
+        tee ${SAMPLE}_out.ns.bam |\
+        samtools sort -@ ${THREADS} -m 2g -u --write-index -o ${SAMPLE}.cs.bam -
+```
+> :warning: If you get any buffer size error then use following args:
+```
+args="--paired_end --filter_pairs --paired_end_minimum_distance 100 --paired_end_maximum_distance 200"
+```
+### 6- Sort by name
+[YaHS](https://github.com/c-zhou/yahs) and [SALSA](https://github.com/marbl/SALSA) require name sorted bam file.
+```
+samtools sort -@ ${THREADS} -n ${SAMPLE}_annotated.pe.bam -o ${SAMPLE}_pe_ns.bam
+```
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+### 7- More pre-processing
 
-## License
-For open source projects, say how it is licensed.
+```
+rename_reads_for_bam.py ${SAMPLE}_pe_ns.bam | samtools view - -@ ${THREADS} -S -h -b -F 3340 -o ${SAMPLE}_poreC.bam
+filter_bam.py ${SAMPLE}_poreC.bam 1 --threads ${THREADS} | samtools view -b -@ ${THREADS} -o ${SAMPLE}_poreC.filtered.bam
+```
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+### 8- Scaffolding
+Now run [YaHS](https://github.com/c-zhou/yahs) to make scaffold.
+```
+yahs -o ${SAMPLE}_yahs genome.contig.fasta ${SAMPLE}_poreC.filtered.bam
+```
\ No newline at end of file
-- 
GitLab