Curso de vibe coding con Python — Parte 5 (final)

Publicar junto con el artículo

Subir el análisis a Zenodo y GitHub

Ilustración de un artículo científico y una caja con código y datos, unidos por dos anillos

Esta es la última parte de la serie. En la Parte 4 creó el archivo requirements.txt y dejó el entorno listo para que otros puedan reproducirlo. Para terminar, esta parte explica cómo subir el paquete de análisis completo a Zenodo, GitHub u otros servicios parecidos y publicarlo junto con su artículo. Una vez publicado, cualquier persona podrá llegar a su código y a su entorno desde el enlace del artículo y reproducir sus figuras y tablas en el momento. Cada vez más revistas exigen que los datos y el código estén disponibles, entre ellas PLOS ONE, las revistas del grupo Nature y eLife. Esta tendencia también llega ya a revistas de agronomía como Field Crops Research.

Dr. Hoo, ya estamos en la última parte.
Así es. Vamos a publicar la carpeta del análisis en Zenodo y GitHub junto con el artículo. Así cualquiera podrá seguir el análisis desde el enlace del artículo.
!

Piense bien cuándo hacer públicos sus datos

¿Conviene publicarlo en cuanto esté listo?
Ahí hay que ir con cuidado. Si se publica demasiado pronto, otra persona podría adelantarse con el artículo. Lo más seguro es hacerlo cuando el artículo ya esté publicado oficialmente.

Antes de entrar en los pasos técnicos, conviene pensar con calma cuándo abrir al público sus datos y su código. Si los publica demasiado pronto, corre el riesgo de perder la prioridad o de que otros publiquen antes un análisis parecido.

Como norma general, el momento más seguro para publicar datos y código es después de que el artículo se haya publicado formalmente tras la revisión por pares. Subir antes una prepublicación deja constancia de la fecha, pero los riesgos siguen existiendo en esa fase (por ejemplo, que otros publiquen un análisis parecido durante la revisión o que sea más difícil controlar la reutilización de los datos). Pasar de Private a Public solo tras la aceptación o la publicación ofrece un equilibrio razonable entre los intereses del investigador y los principios de la ciencia abierta.

A continuación se muestra el procedimiento recomendado durante el envío y la revisión por pares.

  1. Suba el paquete de análisis a GitHub, Zenodo, OSF u otro servicio parecido en modo Private (no público)
  2. En la declaración de disponibilidad de datos y código (Data / Code Availability Statement) del artículo, indique que el repositorio es privado por ahora por motivos de seguridad de los datos y que se hará público con un DOI cuando se publique el artículo. Si se explica con claridad, los editores y revisores suelen aceptarlo
  3. Si los revisores necesitan ver el código, use un enlace para revisores (Anonymous Link / Reviewer Link), disponible en servicios como OSF, Figshare o la función Closed Access de Zenodo
  4. Cuando el artículo se publique, cambie de Private a Public y emita formalmente el DOI en Zenodo

Si la política de la revista exige que los datos sean públicos en el momento del envío, siga sus instrucciones. La mayoría de las revistas aceptan un enlace para revisores durante la revisión y solo piden el acceso público en la publicación. Si tiene dudas, consúltelo antes con el editor.

01

Revisar la estructura de carpetas para la publicación

Si ha seguido los pasos desde la Parte 2, su carpeta ya debería tener este aspecto. Revísela por última vez antes de publicarla.

Estructura de carpetas recomendada para el paquete publicado

my_first_analysis/
├── data/
│   └── sample_data.xlsx  # Datos originales
├── notebooks/
│   └── analysis.ipynb    # Código del análisis
├── results/
│   ├── scatter.png        # Figura generada
│   └── statistics.csv    # Datos generados
├── requirements.txt       # Archivo del entorno
├── README.md             # Instrucciones de uso
└── .gitignore             # Archivos que se excluyen

La carpeta .venv/ queda excluida por .gitignore y no se publica.

Si separa los datos originales, el código del análisis y los resultados en carpetas distintas, cualquiera que abra el paquete entenderá la estructura enseguida. Si la organización se ha desordenado, puede pedir ayuda a un LLM para ponerla en orden.

Si sus datos originales contienen información que permite identificar a personas (por ejemplo, datos de sujetos humanos), anonimícelos o transfórmelos antes de publicarlos, de modo que se puedan compartir. No publique datos que queden fuera de lo autorizado por su aprobación ética.

02

Elegir dónde publicar

Hay varias plataformas para publicar datos y código de investigación. En este curso recomendamos la combinación Zenodo + GitHub. Aun así, conviene conocer las demás opciones para adaptarse a lo que pidan su institución o la revista.

Zenodo

Archivo de datos de investigación gestionado por el CERN (Europa). Cada depósito recibe un DOI. zenodo.org

  • El DOI garantiza un enlace permanente
  • Fácil de citar en la bibliografía de un artículo
  • Límite de 50 GB por archivo y 100 GB en total
  • Sirve para cualquier campo de investigación

GitHub

La mayor plataforma del mundo para compartir código y controlar sus versiones. Muy adecuada para colaborar y actualizar el trabajo de forma continua. github.com

  • Guarda todo el historial de cambios
  • Permite la edición en colaboración
  • No asigna DOI por defecto (se puede obtener mediante la integración con Zenodo)
  • Ideal para proyectos colaborativos o en curso

Figshare

Repositorio de datos de investigación muy integrado con las revistas de Springer Nature. figshare.com

  • Asigna DOI
  • Admite archivos grandes (20 GB gratis)
  • Ofrece enlaces privados para revisores
  • Lo recomiendan a menudo las revistas del grupo Nature

OSF (Open Science Framework)

Gestionado por el Center for Open Science (Estados Unidos). Muy adecuado para gestionar proyectos completos. osf.io

  • Asigna DOI
  • Permite el prerregistro de estudios
  • Límite de 5 GB por archivo, sin límite total
  • Muy usado en psicología y ciencias sociales

Dataverse

Plataforma de código abierto nacida en Harvard, que a menudo gestionan las propias instituciones. dataverse.org

  • Asigna DOI
  • Ideal si su institución tiene su propio Dataverse
  • Gestión de metadatos muy completa
  • Adecuado para almacenar grandes volúmenes de datos a largo plazo

Repositorios específicos de cada campo

Algunos campos tienen repositorios propios cuyo uso se recomienda encarecidamente.

Elija según los requisitos de la revista a la que envía el artículo y las normas de su institución. En este curso recomendamos la combinación «Zenodo + GitHub». Mantenga el trabajo actualizado en GitHub y, en el momento de la publicación, vincule el repositorio de GitHub con Zenodo para obtener un DOI (se explica más abajo).

03

Subir el análisis a GitHub

Para subir el análisis a GitHub se siguen básicamente los mismos pasos con GitHub Desktop que en el artículo «Crear una web de investigador sin programar». Aquí tiene un resumen breve.

  1. Cree una cuenta gratuita en github.com
  2. Haga clic en «+» (arriba a la derecha) → «New repository» y cree un repositorio (por ejemplo, my-first-analysis, en modo Public)
  3. Instale GitHub Desktop desde desktop.github.com
  4. En GitHub Desktop, elija «File → Add Local Repository» y seleccione la carpeta del análisis
  5. Haga clic en «Publish repository» para enviarla a GitHub

Así se crea una URL pública, https://github.com/your-username/my-first-analysis. Cualquiera puede visitarla y descargar la carpeta con «Code → Download ZIP».

04

Obtener un DOI en Zenodo

¿No basta con el enlace de GitHub?
Para un artículo, es mejor un DOI de Zenodo. Es permanente y fácil de citar. Si se conecta con GitHub, se obtiene casi automáticamente.

Para la URL que incluya en el apéndice del artículo, recomendamos un DOI de Zenodo, porque es permanente y fácil de citar. Si vincula Zenodo con GitHub, el DOI se emite de forma casi automática.

  1. Entre en zenodo.org e inicie sesión con su cuenta de GitHub
  2. Abra el menú de usuario (arriba a la derecha) y elija «GitHub» para ver la lista de sus repositorios
  3. Busque el repositorio que quiere publicar (my-first-analysis) y ponga en ON el interruptor que tiene al lado
  4. Vuelva a GitHub, abra la página del repositorio y haga clic en «Releases» (barra lateral derecha) → «Create a new release»
  5. Escriba una etiqueta (por ejemplo, v1.0) y un título, y haga clic en «Publish release»
  6. En pocos minutos, Zenodo crea automáticamente una copia fija y emite un DOI

El DOI tiene la forma 10.5281/zenodo.XXXXXXXX y queda vinculado para siempre a esta copia de su código y su entorno. Mientras el artículo no se retracte, cualquiera en el mundo podrá acceder a ella.

05

Incluir el enlace en el apéndice o en los métodos del artículo

En la sección de métodos, o en la declaración de disponibilidad de datos (Data Availability Statement) o de código (Code Availability Statement), incluya el enlace con un texto como el del ejemplo siguiente. Los artículos suelen escribirse en inglés, así que el ejemplo se muestra en inglés.

Ejemplo de texto para el artículo

The Python code and processed data used to generate all figures and tables in this study are openly available at Zenodo (DOI: 10.5281/zenodo.XXXXXXXX) and GitHub (https://github.com/yourname/my-first-analysis). The analysis was performed using Python 3.12 with the libraries listed in requirements.txt.

El formato exacto varía de una revista a otra, así que consulte sus normas para autores. La mayoría de las revistas tienen una sección propia llamada «Data Availability» o «Code Availability».

06

Seguir actualizando después de publicar

Es habitual mejorar el análisis o añadir datos después de publicar el artículo. Para seguir usando GitHub y Zenodo juntos, el procedimiento es el siguiente.

  1. Modifique el código en su ordenador (con ayuda de un LLM en VSCode) y compruebe que funciona
  2. Haga commit y push con GitHub Desktop (la versión de GitHub se actualiza)
  3. Cuando haga falta, publique una nueva versión (release), por ejemplo v1.1 → Zenodo emite un DOI nuevo para esa versión

Si en su artículo ya se cita un DOI anterior, no hay problema. Zenodo emite un «Concept DOI», que siempre apunta a la última versión, y un «Version DOI», que apunta a una versión concreta. Puede usar el que más le convenga en cada caso.


Fin de la serie

A lo largo de las cinco partes ha aprendido todo el proceso, desde preparar el entorno de Python hasta programar con un LLM mediante vibe coding, garantizar la reproducibilidad y publicar el análisis junto con su artículo.

A partir de aquí solo queda practicar. Recorra el proceso con sus propios datos de investigación, con ChatGPT a su lado. Cada vez que aparezca un error, el LLM le ayudará a encontrar la solución. Le damos la bienvenida a la comunidad de investigadores que comparten su código y construyen una ciencia reproducible.

→

Próximos pasos

  • Repita el proceso de las Partes 2 a 4 con sus propios datos de investigación
  • Si quiere que el código generado sea de más calidad, pruebe un modelo de pago como ChatGPT Plus o Claude Pro
  • Para aprender un control de versiones más avanzado, lea un artículo introductorio sobre Git
  • Comparta esta serie con sus coautores y conviértala en el procedimiento habitual de todo su laboratorio

Puede enviar sus preguntas, comentarios y sugerencias desde Contacto.

Gracias por las cinco partes.
Buen trabajo. Ahora toca probar de nuevo las Partes 2 a 4 con sus propios datos de investigación.