Skip to content

Commit 5d153ab

Browse files
committed
docs updated
1 parent a972963 commit 5d153ab

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![DOI](https://zenodo.org/badge/490592846.svg)](https://doi.org/10.5281/zenodo.14204261)
44
[![GitBook Docs](https://img.shields.io/badge/docs-GitBook-blue?logo=gitbook)](https://jyotirmoys-organization.gitbook.io/TwistMethNext)
5+
[![build-docs](https://github.com/JD2112/TwistMethNext/actions/workflows/build-docs.yml/badge.svg?branch=main)](https://github.com/JD2112/TwistMethNext/actions/workflows/build-docs.yml)
56
[![GitHub Invite Collaborators](https://img.shields.io/badge/Invite-Collaborators-blue?style=for-the-badge&logo=github)](https://github.com/JD2112/TwistMethNext/settings/access)
67

78
[![wakatime](https://wakatime.com/badge/user/fe95275f-909a-4147-a45d-624981173898/project/a44415f0-a274-4c3b-a59a-f8e1067c0fc1.svg)](https://wakatime.com/badge/user/fe95275f-909a-4147-a45d-624981173898/project/a44415f0-a274-4c3b-a59a-f8e1067c0fc1)
@@ -58,7 +59,7 @@ nextflow run JD2112/TwistMethNext \
5859
--genome_fasta /data/reference_genome/hg38/hg38.fa \
5960
--run_both_methods \
6061
--gtf_file /data/Homo_sapiens.GRCh38.104.gtf \
61-
--refseq_file /data/hg19_RefSeq.bed.gz \
62+
--refseq_file /data/hg38_RefSeq.bed.gz \
6263
--outdir Results/TwistMethNext_both
6364
6465
@@ -70,12 +71,12 @@ nextflow run JD2112/TwistMethNext \
7071
--bismark_index /data/reference_genome/hg38/ \
7172
--run_both_methods \
7273
--gtf_file /data/Homo_sapiens.GRCh38.104.gtf \
73-
--refseq_file /data/hg19_RefSeq.bed.gz \
74+
--refseq_file /data/hg38_RefSeq.bed.gz \
7475
--outdir /mnt/Results/TwistMethNext_both
7576
```
7677

7778

78-
### `--diff_meth_method` EdgeR
79+
### `--diff_meth_method`: EdgeR
7980

8081
```
8182
# when using the reference genome indexing, --genome_fasta
@@ -85,7 +86,7 @@ nextflow run JD2112/TwistMethNext \
8586
--sample_sheet Sample_sheet_twist.csv \
8687
--genome_fasta /data/reference_genome/hg38/hg38.fa \
8788
--diff_meth_method edger \
88-
--refseq_file /data/hg19_RefSeq.bed.gz \
89+
--refseq_file /data/hg38_RefSeq.bed.gz \
8990
--outdir Results/TwistMethNext_edgeR
9091
9192
@@ -96,11 +97,11 @@ nextflow run JD2112/TwistMethNext \
9697
--sample_sheet Sample_sheet_twist.csv \
9798
--bismark_index /data/reference_genome/hg38/ \
9899
--diff_meth_method edger \
99-
--refseq_file /data/hg19_RefSeq.bed.gz \
100+
--refseq_file /data/hg38_RefSeq.bed.gz \
100101
--outdir /mnt/Results/TwistMethNext_edgeR
101102
```
102103

103-
### `--diff_meth_method` MethylKit
104+
### `--diff_meth_method`: MethylKit
104105

105106
```
106107
# when using the reference genome indexing, --genome_fasta
@@ -125,7 +126,7 @@ nextflow run JD2112/TwistMethNext \
125126
--outdir Results/TwistMethNext_methylKit
126127
```
127128
## Options:
128-
--------
129+
129130
| options | Description |
130131
|--------|-----------------------------------------------------------|
131132
| `--sample_sheet` | Path to the sample sheet CSV file (required) |
@@ -155,7 +156,7 @@ nextflow run JD2112/TwistMethNext \
155156
```
156157
nextflow run JD2112/TwistMethNext --help --outdir .
157158
```
158-
Find the details on the [manual](https://jyotirmoys-organization.gitbook.io/TwistMethNext)
159+
Find the details on the [manual](https://jd2112.github.io/TwistMethNext/)
159160

160161
## Credits
161162
- Main Author:
@@ -171,7 +172,7 @@ Das, J. (2024). TwistMethNext (v1.0.0). Zenodo. [https://doi.org/10.5281/zenodo.
171172

172173
## HELP/FAQ/Troubleshooting
173174

174-
Please check the [manual](https://jyotirmoys-organization.gitbook.io/TwistMethNext) for details.
175+
Please check the [manual](https://jd2112.github.io/TwistMethNext/) for details.
175176

176177
Please create [issues](https://github.com/JD2112/TwistMethNext/issues) on github.
177178

@@ -181,4 +182,4 @@ Please create [issues](https://github.com/JD2112/TwistMethNext/issues) on github
181182

182183
## Acknowledgement
183184

184-
We would like to acknowledge the **Core Facility, Faculty of Medicine and Health Sciences, Linköping University, Linköping, Sweden** and **Clinical Genomics Linköping, Science for Life Laboratory, Sweden** for their support. We are grateful to PDC (KTH, Sweden) support for computational support to test and validate the pipeline on the Dardel HPC.
185+
We would like to acknowledge the **Core Facility, Faculty of Medicine and Health Sciences, Linköping University, Linköping, Sweden** and **Clinical Genomics Linköping, Science for Life Laboratory, Sweden** for their support. We are grateful to **PDC (KTH, Sweden)** support for computational support to test and validate the pipeline on the *Dardel* HPC.

artworks/TN.png

57.3 KB
Loading

0 commit comments

Comments
 (0)