Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
dialvarezs committed Sep 30, 2024
1 parent 07dec2b commit d64e5c5
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 12 deletions.
10 changes: 10 additions & 0 deletions document/catgconf.typ
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,16 @@
doc
}

#let cmd(content) = {
show: box.with(
fill: rgb("f9f9f9"),
stroke: luma(218) + 0.3pt,
inset: (x: 2pt, y: 0pt),
outset: (x: 0pt, y: 3pt),
radius: 2pt,
)
content
}

#let pill(content, fill: gray) = {
set text(weight: "regular", size: 9pt)
Expand Down
7 changes: 2 additions & 5 deletions document/main.typ
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,9 @@
number-format: none,
zebra-fill: none,
fill: rgb("f9f9f9"),
inset: 4pt,
)

#include "sections/1_basecalling.typ"
#include "sections/1_cli_and_conda.typ"
#include "sections/2_basecalling.typ"
#include "sections/3_taxonomic_assign.typ"
#include "sections/3_diversity.typ"



11 changes: 11 additions & 0 deletions document/sections/1_cli_and_conda.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#import "../catgconf.typ": cmd

= Línea de Comandos

La línea de comandos es una interfaz de texto que permite interactuar con el sistema operativo mediante comandos. Su uso es fundamental al realizar análisis bioinformáticos, ya que la mayoría de las herramientas no cuentan con una interfaz gráfica, además de ofrecer ventajas a la hora de automatizar y ejecutar tareas en entornos HPC o en la nube.

Un comando es una instrucción que se escribe en la terminal y que se ejecuta al presionar la tecla Enter. Cada comando tiene una estructura específica, comunmente similar a la siguiente:
```sh
comando [subcomando] [opciones] <argumentos>
```
Los #cmd(`<argumentos>`) generalmente corresponde a los archivos de entrada y salida del comando y son obligatorios. Por otro lado, las opciones se utilizan para modificar el comportamiento del comando y suelen ser opcionales. Normalmente se usa el formato #cmd(`--opcion`) (forma larga) o #cmd(`-o`) (forma corta) y pueden tener un argumento asociado a la opción. Dependiendo de la herramienta, pueden existir #cmd(`[subcomandos]`).
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#import "@preview/gentle-clues:0.9.0": *

#import "../catgconf.typ": github-pill
#import "../catgconf.typ": github-pill, cmd


= Basecalling
Expand All @@ -26,9 +26,9 @@ Dorado cuenta con múltiples modelos de basecalling, cada uno con diferentes equ
[Requerimientos computacionales],
),

[fast \[`fast`\]], [95.5%], [],
[high accuracy \[`hac`\]], [99.25%], [],
[super accuracy \[`sup`\]], [99.75%], [],
[fast (`fast`)], [95.5%], [],
[high accuracy (`hac`)], [99.25%], [7.5 veces lo requerido por `fast`],
[super accuracy (`sup`)], [99.75%], [8.5 veces lo requerido por `hac`],
),
)

Expand All @@ -49,16 +49,16 @@ Dorado posee múltiples subcomandos con distintas funcionalidades, que incluyen

=== Basecalling

Para basecalling, se utiliza el subcomando `dorado basecaller`. La forma más básica de ejecutar este comando necesita el modelo a utilizar en el basecalling y el directorio con los archivos POD5. Por ejemplo, si tenemos el directorio `pod5/` y queremos utilizar el modelo `sup`, se ejecuta el siguiente comando:
Para basecalling, se utiliza el subcomando #cmd(`dorado basecaller`). La forma más básica de ejecutar este comando necesita el modelo a utilizar en el basecalling y el directorio con los archivos POD5. Por ejemplo, si tenemos el directorio `pod5/` y queremos utilizar el modelo `sup`, se ejecuta el siguiente comando:
```sh
dorado basecaller sup pod5/ > reads.ubam
```
Adicionalmente, existen múltiples opciones adicionales que se pueden visualizar en la ayuda del comando.

=== Demultiplexación

Para demultiplexar los archivos basecalled, se utiliza el subcomando `dorado demux`. Este comando requiere el archivo UBAM con los reads generado en el basecalling y el kit de barcoding. Por ejemplo, si tenemos el archivo el `reads.ubam` y el kit SQK-NBD114-24:
Para demultiplexar los datos, se utiliza el subcomando #cmd(`dorado demux`). Este comando requiere el archivo UBAM con los reads generado en el basecalling y el kit de barcoding. Por ejemplo, si tenemos el archivo el `reads.ubam` y el kit SQK-NBD114-24:
```sh
dorado demux --output-dir basecalled_reads --kit-name SQK-NBD114-24 --emit-fastq reads.ubam
```
En este ejemplo, `--output-dir` indica el directorio donde se guardarán los archivos demultiplexados, y `--emit-fastq` se utiliza para que los archivos generados estén en formato FASTQ (por defecto, se generan en BAM).
En este ejemplo, #cmd(`--output-dir`) indica el directorio donde se guardarán los archivos demultiplexados, y #cmd(`--emit-fastq`) se utiliza para que los archivos generados estén en formato FASTQ (por defecto, se generan en BAM).

0 comments on commit d64e5c5

Please sign in to comment.