Better, transparent science

Transparent practices changes the way you write your papers
Author

Daniel Hammarström

Published

November 8, 2023

Today, in our department’s weekly lunch seminar, we discussed how to start and finish a scientific paper. A summary of the main topic of discussion is that you need to decide on a strategy and then start writing. It does not matter if you start with the abstract, the figures, the methods, or the main results. Ideally, you select a journal before you start writing to ensure you do not need to revise or restructure before the first submission.

I think that this is, however, secondary to another related point, which is that your paper is only one potential output from your science project. Other outputs could be the data set and the source code used to generate the paper. These could be combined in a version-controlled repository and made public as a way of being transparent about the whole process.

Aiming for transparency affects the way you think about preparing your manuscript. Writing the source files for the manuscripts invites you to explain how and why you have prepared and analyzed data the way you did. To align the manuscript to the source file, you might need to drop some troublesome ideals of scientific writing. One such ideal is the tendency to build a scientific investigation on a (genius) hypothesis. This hypothesis is, of course, formulated before collecting any data and confirmed in the paper. In reality, many papers do not have a pre-data hypothesis; it is probably made up to fit the format of hypothesis-driven research, a practice known as HARKing.

It is not that I do not like hypothesis-driven research; it’s just that if you wish to test a hypothesis, this should be done formally. This might include publishing a detailed background and analysis plan with pilot data or simulations. Deviations from the plan are OK, as reality might differ from assumptions, and such deviations are also a way of learning about the phenomena we are studying.

Hypothesis-generating or descriptive research can also help us learn about our phenomena. All research does not need a pre-formulated hypothesis, and more papers should have been written without one. A project in which we learn stuff as we explore the data naturally does not contain a single pre-formulated hypothesis. Aligning the wording of a manuscript to the process of writing it is a benefit of working not only on your manuscript but on the whole scientific process. This process is ideally documented in a public repository.

Let us aim to be open about our shortcomings. I have most likely contributed to projects that were not fully transparent and included some version of HARKing in the past. However, I hope the next project I’m involved in is a little bit better than the last one in terms of transparency. Small steps are better than no steps.