ComdTeX

Biología computacional

ComdTeX 1.31 añade un conjunto de herramientas para papers que salen de un pipeline computacional. Esta página es el mapa: qué existe, cómo activarlo y dónde se explica cada pieza en detalle.

Actívalo

Las convenciones de biología son opcionales, por documento, en el frontmatter:

---
comdtex.domain: biology
comdtex.organism: human
---

comdtex.domain: biology activa los chequeos tipográficos, los enlaces de acceso y la nota de disponibilidad de datos. comdtex.organism (opcional) hace que los chequeos de genes sigan las convenciones de un organismo. Las plantillas de revista de biología definen el dominio por ti. Las demás herramientas de esta página (val(), :::seq, la numeración del suplemento, las citas de PubMed, los archivos .qmd) no necesitan ningún interruptor.

Las herramientas

QuieresUsaDetalles
Citar n, un valor p o un AUC de la salida de tu pipelineval(stats, pvalue, p)Tablas desde datos
Enlazar SRR1234567 o GSE12345 con su base de datosAutomático con el dominio activoUnidades, química y convenciones
Recibir un recordatorio de disponibilidad de datosAutomático con el dominio activoUnidades, química y convenciones
Poner en cursiva genes y especies según tu organismocomdtex.organism y Ctrl+.Unidades, química y convenciones
Numerar figuras y tablas suplementarias S1, S2<!-- supplement -->Etiquetas y referencias
Mostrar una secuencia de ADN, ARN o proteína:::seqDiagramas y dibujos
Citar un paper por PMID o PMCIDCitation ManagerCitas y bibliografía
Partir de un diseño de PLOS, Bioinformatics, BMC o bioRxivNueva desde plantillaPlantillas de journal
Escribir en Quarto o R Markdown, o traer un notebook.qmd, .Rmd, Importar documentoObsidian y Overleaf

Un paper que lee sus resultados

La idea central es que el manuscrito no debe guardar una segunda copia de tus números. Tu pipeline escribe un archivo de resultados (CSV o JSON) en el vault. Lo declaras una vez y citas de él:

---
comdtex.domain: biology
comdtex.organism: mouse
---

:::data{#data:stats}
results/stats.csv
:::

La pérdida de *Trp53* aumentó la incidencia de tumores (val(stats, pvalue, p)), n = val(stats, n),
con un efecto medio de si(val(stats, effect, 3sf), mg/L).

Cuando el pipeline se vuelve a ejecutar y el archivo cambia, los números de la vista previa y de todas las exportaciones cambian con él. Si falta un valor, una nota visible ocupa su lugar y el editor te avisa. ComdTeX solo lee el archivo: no ejecuta tu análisis y no puede saber que el archivo está desactualizado.

Lo que los chequeos no hacen

  • Advierten; nunca reescriben tu texto sin que lo pidas (Ctrl+. aplica una corrección que tú eliges).
  • Son conservadores a propósito, para evitar ruido. Un gen que el chequeo no marca no es necesariamente correcto, y no hay una base de datos de símbolos de genes detrás.
  • Los enlaces de acceso se construyen por la forma del identificador. ComdTeX no comprueba que el registro exista.
  • Nada de esto ejecuta código, alinea secuencias ni consulta una base de datos, salvo obtener una cita cuando tú lo pides.

Páginas relacionadas

Computational biology

ComdTeX 1.31 adds a set of tools for papers that come out of a computational pipeline. This page is the map: what exists, how to switch it on, and where each piece is explained in detail.

Switch it on

The biology conventions are opt-in, per document, in the frontmatter:

---
comdtex.domain: biology
comdtex.organism: human
---

comdtex.domain: biology enables the typography checks, accession links and the Data availability note. comdtex.organism (optional) makes the gene checks follow one organism’s conventions. The journal templates for biology set the domain for you. The other tools on this page (val(), :::seq, supplementary numbering, PubMed citations, .qmd files) need no switch.

The tools

You want toUseDetails
Quote n, a p-value or an AUC from your pipeline’s outputval(stats, pvalue, p)Tables from data
Link SRR1234567 or GSE12345 to its databaseAutomatic with the domain onUnits, chemistry and conventions
Get a Data availability reminderAutomatic with the domain onUnits, chemistry and conventions
Italicize genes and species correctly for your organismcomdtex.organism and Ctrl+.Units, chemistry and conventions
Number supplementary figures and tables S1, S2<!-- supplement -->Labels and references
Show a DNA, RNA or protein sequence:::seqDiagrams and drawings
Cite a paper by PMID or PMCIDCitation ManagerCitations and bibliography
Start from a PLOS, Bioinformatics, BMC or bioRxiv layoutNew from templateJournal templates
Write in Quarto or R Markdown, or bring in a notebook.qmd, .Rmd, Import documentObsidian and Overleaf

A paper that reads its results

The central idea is that the manuscript should not hold a second copy of your numbers. Your pipeline writes a results file (CSV or JSON) into the vault. You declare it once and quote from it:

---
comdtex.domain: biology
comdtex.organism: mouse
---

:::data{#data:stats}
results/stats.csv
:::

Loss of *Trp53* raised tumor incidence (val(stats, pvalue, p)), n = val(stats, n),
with a mean effect of si(val(stats, effect, 3sf), mg/L).

When the pipeline reruns and the file changes, the numbers in the preview and in every export change with it. If a value is missing, a visible note takes its place, and the editor warns you. ComdTeX only reads the file: it does not run your analysis, and it cannot know that the file is out of date.

What the checks do not do

  • They warn; they never rewrite your text without you asking (Ctrl+. applies a fix you choose).
  • They are conservative on purpose, to avoid noise. A gene the check does not flag is not necessarily correct, and there is no gene symbol database behind it.
  • Accession links are built from the identifier’s shape. ComdTeX does not check that the record exists.
  • Nothing here runs code, aligns sequences or queries a database, other than fetching a citation when you ask for one.