Skip to content

Commit 4cfcac8

Browse files
committed
Add Spanish translations of the repository READMEs
Provide .es.md siblings of the main README and the example/, tests/scenarios/ and frontend/demo/ READMEs, each pair linked by an English/Español switcher line, for readers browsing the repository on GitHub.
1 parent c390de9 commit 4cfcac8

8 files changed

Lines changed: 779 additions & 0 deletions

File tree

README.es.md

Lines changed: 388 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616
[Quick Start](#quick-start) · [GUI](#desktop-gui) · [Features](#features) · [Docs](docs/) · [Citation](#citation)
1717

18+
**English** · [Español](README.es.md)
19+
1820
</div>
1921

2022
__Paula Ruiz-Rodriguez<sup>1</sup>__

example/README.es.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Conjunto de datos de ejemplo
2+
3+
[English](README.md) · **Español**
4+
5+
Un pequeño conjunto de datos de *M. tuberculosis* para probar get_MNV de principio
6+
a fin, incluido el visor de lecturas de la GUI.
7+
8+
| Archivo | Qué es |
9+
|---|---|
10+
| `MTB_ancestor.fas` (`.fai`) | Referencia, un único contig `MTB_anc` (4,411,532 bp) |
11+
| `anot_genes.txt` | Tabla de genes: `name`, `start`, `end`, `strand` (separados por tabuladores) |
12+
| `G35894.var.snp.vcf` | Llamadas VCF estilo VarScan para la muestra G35894 |
13+
| `G35894.var.snp.MNV.tsv` | Salida de get_MNV precalculada para ese VCF (sin BAM) |
14+
| `G35894.demo.bam` (`.bai`) | Alineamiento sintético diminuto para el visor de lecturas (ver abajo) |
15+
| `make_demo_bam.py` | Regenera `G35894.demo.bam` a partir de la referencia |
16+
17+
## Ejecuta la CLI
18+
19+
```bash
20+
get_mnv \
21+
--vcf example/G35894.var.snp.vcf \
22+
--fasta example/MTB_ancestor.fas \
23+
--genes example/anot_genes.txt
24+
```
25+
26+
Esto reproduce `G35894.var.snp.MNV.tsv`: 941 variantes (797 SNP, 10 SNP/MNV,
27+
134 intergénicas) en 635 genes anotados.
28+
29+
## Visualiza las lecturas
30+
31+
`G35894.demo.bam` es un alineamiento **sintético diminuto** (24 lecturas, ~200 bp) sobre
32+
un único MNV real de esta muestra, de modo que el soporte de lecturas y el pileup de la GUI funcionen de
33+
fábrica:
34+
35+
> gen `Rv2036` (hebra +), posición genómica `2282376` y `2282377`, codón `GTT → GCC`
36+
> (Val93Ala). Todas las lecturas portan ambas bases ALT, repartidas equitativamente entre las hebras.
37+
38+
Añade `--bam` para contar el soporte de lecturas a partir de él:
39+
40+
```bash
41+
get_mnv \
42+
--vcf example/G35894.var.snp.vcf \
43+
--fasta example/MTB_ancestor.fas \
44+
--genes example/anot_genes.txt \
45+
--bam example/G35894.demo.bam --mnv 1
46+
```
47+
48+
La fila `Rv2036` `2282376, 2282377` informa entonces `MNV Reads=24` (12 forward /
49+
12 reverse), `MNV Frequencies=1.0000`.
50+
51+
En la GUI de escritorio, carga el VCF, el FASTA, la tabla de genes y `G35894.demo.bam`, ejecuta,
52+
y luego abre esa fila `SNP/MNV` para ver las 24 lecturas en el pileup.
53+
54+
> El BAM de demostración solo cubre ese único locus, por lo que las lecturas se muestran únicamente ahí. Para un
55+
> análisis real, proporciona tu propio BAM ordenado por coordenadas e indexado.
56+
57+
## Regenerar el BAM de demostración
58+
59+
```bash
60+
cd example && python3 make_demo_bam.py # needs samtools on PATH (or $SAMTOOLS)
61+
```

example/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Example dataset
22

3+
**English** · [Español](README.es.md)
4+
35
A small *M. tuberculosis* dataset for trying get_MNV end to end, including the
46
GUI read viewer.
57

frontend/demo/README.es.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Banco de pruebas de demostración de BamViewer
2+
3+
[English](README.md) · **Español**
4+
5+
Renderiza el componente real `BamViewer` en un navegador corriente, sin lanzar la
6+
app de escritorio completa de Tauri. El comando `get_bam_view` de Tauri está mockeado
7+
(`tauri-core-mock.ts`) para devolver un fixture capturado del motor central, de modo que el
8+
pileup de lecturas, las pistas de codón/AA, la cobertura y las filas de referencia se renderizan exactamente como en
9+
la app.
10+
11+
```bash
12+
cd frontend
13+
npm install # first time only
14+
npm run demo # serves the demo at http://localhost:5180
15+
```
16+
17+
Añade `?reads=1` a la URL para desplazar automáticamente el pileup de lecturas hasta la vista.
18+
19+
## Fixtures
20+
21+
- `sample_bam_view.json` — una respuesta real de `get_bam_view` para el escenario `02a`
22+
(`chr_test` MNV `28 G>T` / `30 T>A`, codón `GCT→TCA` = Ala10Ser, 20 lecturas de
23+
apoyo), producida llamando al comando del backend de la GUI sobre el BAM/FASTA del escenario.
24+
- `sample_tsv.json` — el `TsvData` correspondiente, parseado a partir del
25+
`variants.MNV.tsv` de ese escenario.
26+
27+
Para actualizar los fixtures, llama a `get_bam_view` (src-tauri) sobre un directorio de trabajo de un escenario
28+
y serializa la respuesta; luego convierte el `.MNV.tsv` del escenario a
29+
`{headers, rows}`.

frontend/demo/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# BamViewer demo harness
22

3+
**English** · [Español](README.es.md)
4+
35
Renders the real `BamViewer` component in a plain browser, without launching the
46
full Tauri desktop app. The Tauri `get_bam_view` command is mocked
57
(`tauri-core-mock.ts`) to return a fixture captured from the core engine, so the

tests/scenarios/README.es.md

Lines changed: 293 additions & 0 deletions
Large diffs are not rendered by default.

tests/scenarios/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# End-to-end scenario tests
22

3+
**English** · [Español](README.es.md)
4+
35
This directory contains a Python test harness that builds synthetic FASTA,
46
GFF, VCF (or iVar TSV) and BAM inputs from declarative scenario
57
definitions, runs `get_mnv` on each one, and checks the output TSV against

0 commit comments

Comments
 (0)