Anotaciones Científicas

algunas recomendaciones para escribir
Quarto
R
Python
Julia
Author
Affiliation
Published

December 7, 2023

En lo que sigue revisaremos un par de opciones de generar anotaciones (algo así como jupyter notebooks) científicas que contengan referencias bibliográficas y tratamiento de datos con un estándar de transparencia científica.

Lo primero que hay que entender es la necesidad de documentar anotaciones y avances que requieren referencias bibliográficas como deducciones (uso de lenguaje matemático en formato \(\LaTeX\), cálculos tando numéricos como simbólicos). Esto se puede hacer nativamente en \(\LaTeX\) a través de BibTeX con el costo de la ineficiencia al tener que escribir \begin{ en muchas partes. Para una deducción teórica, eso puede ser suficiente aunque ineficiente. Si es necesario hacer cálculos, \(\LaTeX\) se queda corto y soluciones como Sweave o knitr permiten integrar apuntes con gestión automatizada de la bibliografía y cálculos. Siempre digo que antiguamente uno escribía sus códigos con muchos comentarios (anteponiendo # o % dependiendo del lenguaje, ya no recuerdo cómo se hacía en Stata), ahora uno puede escribir directamente el documento final con el código incrustado tras bambalinas.

La simplificación de los muchos \begin de \(\LaTeX\) vino hace un tiempo de la mano de Markdown que poco a poco se ha ido integrando a los entornos de desarrollo de diferentes lenguajes. Así, se ha ido integrando a diferentes proyectos donde el más importante para nosotros es pandoc que es un conversor de documentos entre diferentes formatos.

En resumen, vamos a condensar lo que antiguamente podrían ser más de 4 documentos (apunte formato pdf/doc, código en lenguaje de su preferencia, outputs del código como tablas o gráficos y base de datos bibliográfica por ejemplo bib) en 2 archivos (podría ser uno solo) que, más encima, van a ser agnósticos respecto del formato en el cuál usted quiere entregar el resultado (Word, PDF, Web).

RStudio + Quarto

RStudio es un IDE que está basado en una interfaz para R. Sin embargo, ha evolucionado (quizá de la mano de Microsoft) en ser una entorno de trabajo para mucho más que R. RStudio será nuestro editor de documentos en esta sección y Quarto el corazón del formato en el que escribiremos. Ambos están integrados por lo que basta instalar RStudio para aprovechar de ambos.

Entonces de modo muy general, este entorno nos provee de un protocolo de escritura muy simple donde en una suerte de membrete (el YAML header) del archivo vamos a definir además del título/autor, el formato de “publicación” del reporte/documento. Adelante, por favor compila tu primer archivo .qmd siguiente este tutorial.

Desafío: Modifica el hello.qmd del tutorial antes mencionado para incorporar datos de un activo financiero y una referencia científica relacionada.

Anaconda/JupyterLab + Quarto

Para quienes les de susto aprender un lenguaje nuevo y quieren mantenerse en su zona de confort Python. Aún podemos hacer algo y trabajar en un entorno de jupyter notebook. Primero hay que instalar Quarto, siguiendo los pasos acá. Para luego ocupar el mismo formato con el YAML header en un archivo .ipynb siguiendo este tutorial.

Apuntes

Es importante tomar apuntes y/o copiar citas (almacenarlas debidamente con comillas en los textos copiados para evitar problemas de plagio) de argumentos importantes durante lass lectura. En particular los apuntes deben servir para hacer una clase o exposición del tema de forma sucinta tanto como para tener un juicio experto de la temática. Adicionalmente, si un editor de una revista le pide un juicio experto (referee report), Usted deberá seguir un formato preciso para su informe (Berk, Harvey, and Hirshleifer 2017).

Priorizar la lectura

En el flujo de selección descrito anteriormente se pone de relieve que los artículo no se leen “de punta a cabo” la primera vez. Primero hay que dar una revisión “en diagonal” partiendo por las palabras claves que nos hicieron llegar a él, su título, el abstract y luego la introducción. Una vez que la introducción fue leída en detalle y se tiene un juicio positivo del contenido del artículo, entonces se evalúa una lectura del contenido metodológico del artículo.

Para lo anterior, es esencial entender el valor informativo que puede darnos la introducción del artículo. Principalmente, ella debe ponernos al día de la materia de estudio y otras contribuciones (artículos) relacionadas. Debe explicar el problema y la metodología utilizada con especial énfasis en la relación con la literatura existente. Luego, una introducción se termina con la propuesta de los autores de cómo abordar el problema con la metodología enunciada y como ese trabajo se estructura en lo que queda del texto.

References

Berk, Jonathan B., Campbell R. Harvey, and David Hirshleifer. 2017. “How to Write an Effective Referee Report and Improve the Scientific Review Process.” Journal of Economic Perspectives 31 (1): 231–44. https://doi.org/10.1257/jep.31.1.231.

Citation

BibTeX citation:
@online{cea2023,
  author = {Cea, Sebastián},
  title = {Anotaciones {Científicas}},
  date = {2023-12-07},
  url = {https://sebacea.info/posts/2023-07-17-tutorial-anotaciones-científicas/},
  langid = {en}
}
For attribution, please cite this work as:
Cea, Sebastián. 2023. “Anotaciones Científicas.” December 7, 2023. https://sebacea.info/posts/2023-07-17-tutorial-anotaciones-científicas/.