Skip to content

Commit c97dd1e

Browse files
r1ckhdkjvsguerra
andauthored
Add juicer module to docs (#15)
* Add juicer module * Fix formatting and link in README.md Updated README.md to correct formatting and links. --------- Co-authored-by: João Victor Guerra <[email protected]>
1 parent 522ecb2 commit c97dd1e

File tree

3 files changed

+96
-0
lines changed

3 files changed

+96
-0
lines changed

src/07-programas-e-aplicativos/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ Os programas e aplicativos relacionados à análise, processamento e visualizaç
6666
- [HiC2Cool](./hic2cool/index.html)
6767
- [HiCExplorer](./hicexplorer/index.html)
6868
- [HiCsuntdracones](./hicsuntdracones/index.html)
69+
- [Juicer](./juicer/index.html)
6970
- [Pairix](./pairix/index.html)
7071
- [pairtools](./pairtools/index.html)
7172
- [pyGenomeTracks](./pygenometracks/index.html)
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Juicer
2+
3+
[Juicer](https://github.com/aidenlab/juicer) é um pipeline completo para processamento e análise de dados Hi-C, desenvolvido pelo [Aiden Lab](https://aidenlab.org/). Ele automatiza desde o alinhamento das leituras até a geração de mapas de interação genômica em múltiplas resoluções (arquivos **.hic**).
4+
5+
Útil para explorar estruturas 3D do genoma — como **TADs, loops** e **compartimentos** — o Juicer é amplamente adotado em genômica estrutural.
6+
7+
Para mais informações, acesse <https://github.com/aidenlab/juicer/wiki>.
8+
9+
## Carregando o módulo
10+
11+
Para habilitar o juicer no HPCC Marvin, você deve carregar o módulo `juicer`:
12+
13+
```bash
14+
module load juicer/<versão desejada>
15+
```
16+
17+
<div class="warning">
18+
<br>As versões disponíveis do juicer no HPCC Marvin são:
19+
<ul>
20+
<li><code>juicer/2.0 (D)</code></li>
21+
<li><code>juicer/1.6</code></li>
22+
</ul>
23+
Onde <code>(D)</code> indica a versão padrão.<br>
24+
</div>
25+
26+
Para acessar a documentação do modulo, utilize:
27+
28+
```bash
29+
module help juicer
30+
```
31+
32+
## Executando o módulo
33+
34+
O script principal do juicer é chamado com o comando `juicer.sh` e pode ser executado conforme o exemplo:
35+
36+
```bash
37+
juicer.sh -z [reference genome file]
38+
```
39+
40+
Para mais informações detalhadas sobre o script do juicer, acesse a [página de Usage do juicer](https://github.com/aidenlab/juicer/wiki/Usage).
41+
42+
Além do script principal, o módulo também conta com o pacote de ferramentas `juicer_tools`. Para obter informações sobre o uso e ajuda, execute:
43+
44+
```bash
45+
juicer_tools -h
46+
```
47+
48+
Para mais informações, acesse a [página de Quick Start do juicer tools](https://github.com/aidenlab/juicer/wiki/Juicer-Tools-Quick-Start).
49+
50+
Note que, na wiki do juicer tools, ele estará referenciado como juicebox_tools.jar e chama o java para executar o .jar. Isso não é necessário no Marvin, apenas passe as opções e comandos diretamente.
51+
52+
Por exemplo, caso você queira executar o seguinte comando que está na wiki do juicer tools:
53+
54+
```bash
55+
java -Xmx2g -jar juicebox_tools.jar pre data/test.txt.gz data/test.hic hg19
56+
```
57+
58+
No Marvin, você executaria da seguinte forma:
59+
60+
```bash
61+
juicer_tools pre data/test.txt.gz data/test.hic hg19
62+
```
63+
64+
65+
## Submetendo jobs
66+
67+
A execução do juicer no HPCC Marvin é feita por meio de scripts de submissão no SLURM. Crie um arquivo de script, por exemplo `juicer.sh`, com o seguinte conteúdo:
68+
69+
```bash
70+
#!/bin/bash
71+
#SBATCH --job-name=juicer
72+
#SBATCH --partition=short-cpu
73+
#SBATCH --ntasks=1
74+
#SBATCH --cpus-per-task=8
75+
#SBATCH --mem-per-cpu=4GB
76+
77+
module load juicer/2.0
78+
79+
REFERENCE_GENOME="caminho/para/genome/file"
80+
81+
juicer.sh -z "$REFERENCE_GENOME"
82+
```
83+
84+
Para submeter o job, salve o script e utilize o comando `sbatch`:
85+
86+
```bash
87+
sbatch juicer.sh
88+
```
89+
90+
Para mais detalhes sobre os parâmetros do juicer, use:
91+
92+
```bash
93+
juicer.sh -h
94+
```

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
- [HiCsuntdracones](07-programas-e-aplicativos/hicsuntdracones/README.md)
3939
- [Ilastik](07-programas-e-aplicativos/ilastik/README.md)
4040
- [IsoNet](07-programas-e-aplicativos/isonet/README.md)
41+
- [Juicer](07-programas-e-aplicativos/juicer/README.md)
4142
- [kraken2](07-programas-e-aplicativos/kraken2/README.md)
4243
- [NP³ MS WORKFLOW](07-programas-e-aplicativos/np3_ms_workflow/README.md)
4344
- [Criando Sbatch](07-programas-e-aplicativos/np3_ms_workflow/np3_sbatch.md)

0 commit comments

Comments
 (0)