Does anyone using Quarto or R Markdown to draft manuscripts for peer-reviewed journals?

Hi,

I am genuinely curious if anyone is using RMarkdown or Quarto to prepare scientific manuscripts for submission to peer-reviewed journals? Not using a pre-defined TeX template or one of the Quarto journal formats. Spinning up a PDF or Word format manuscript and submitting it to a journal. If so, I have some questions...

  1. Which formats do you render to? I prefer to render to TeX/PDF to get a nicely formatted manuscript. My co-authors (and some journals) require Word documents to provide feedback, but this is by far the most annoying format to work with and getting appearance-parity with PDF is generally a nightmare.

  2. Tables. How? Seriously, this has got to be the most annoying aspect of scientific manuscripts via Quarto/RMarkdown. I still just create my tables manually in a separate Word document. What is everyones strategy for creating publication-ready tables for PDF or Word documents?

  3. How do you deal with the annoying and specific submission guidelines for each journal? Do you tweak your Quarto/R Markdown for each journal you submit to?

I'm really looking to use Quarto for manuscript drafting, but too often I've had to resort to rendering a Word document and then making manual changes to conform to submission guidelines. It defeats most of the purpose of reproducible documents.

Any insight would be great.

Hi @mattwarkentin !
I work on the biological science area and I ran into the same questions. Unfortunately, since I collaborate with people that won't migrate into reproducible documents workflow; I almost had to abandon this quest. And like you said, even some journals accept only msword files. Regardless, I gave it a long thought on how to try to adopt this practice, eventually rendering to msword for publication/collaboration. Assuming you are/will be using RStudio, here are my thoughts:

This is the most annoying part. There is no simple way to approach collaboration if people aren't willing to migrate to a markdown format. The best approximation I could find is the Trackdown package by Emily Kothe et al. It is far from ideal, and it requires everyone to agree on some workflow ground-rules, but it tackles one of the most difficult issues on collaboration (i.e: Tracking changes to manuscripts). It requires working on google docs files, though. I do not know if there are programs/platforms that let you achieve this in a seamless way. You could try Jupiter notebooks, but I find that the tex formatting is less appealing that markdown (specially if you are collaborating with non-tech savvy people).

Edit: Googling stuff for this post I ran into Manuscript. I haven't tested it, but maybe it's worth looking into.

Regarding rendering, I only render into msword, using a template docx file. Journal guidelines usually only require minimum page and typography formatting so you can easily create your own templates; if you can't find any online. Regarding Tex/PDF, if you are lucky and your journal accepts tex files, they usually have their own template. Other than that, journals will do their own formatting, so I fail to find a reason to try and do it myself.

Two ways. If you use R for data processing, or otherwise manage to load your data tables into R (from excel save as .csv and load it into R), I suggest you look into the kableExtra package by Hao Zhu. If you don't, I would stick with MS Excel/Word (or googles alternatives) for simplicity. I don't think markdown was conceived for complex tables.

Not an easy answer. Journal guidelines mostly focus on how to process figures and tables, how to cite, word count, symbols and abbreviations, etc. Most of these you will type, so read the guidelines and try to keep them in mind when writing. What can be standardized is citation style, font type/size, and page format. As I said, if you're lucky, the journal you want to publish with will have a Tex template, otherwise create a standard msword template that's easy to collaborate with (double spaced, numbered lines, etc.). Again, final formatting will be done by the journal. For citations, I recommend you use Mendeley/Zotero (or whichever reference manager you like) and export you citations in .bib format (make sure you assign a Citation Key to each reference) and cite in your manuscript as you write. Next, download the appropriate .CSL file (in github citation-style-language/styles or zotero styles) for your journal and set it in your YAML (see in 'R for Data Science' online book the 'YAML Header' section).

In conclusion, it is not a streamlined process. But that doesn't mean it isn't worth it. I'm currently using quarto/RMarkdown for writing my thesis. I created a RStudio project, a global _quarto.yml config file, and a .qmd file for each chapter/section. I plan on creating all my figures and tables with ggplot and kableExtra, and embedding them inline with the text. I have a draft template and will create a final version template for final proofreading and publication purposes. Drafts will be send to my adviser and I will use msword track changes function to manually pour them into the .qmd (this will be very annoying, but googledocs and trackdown is sadly not an option). The final version will eventually be converted into PDF. References are managed with Mendeley and an appropriate CSL. Lastly, everything is tracked with git, so I can easily revert any change, while also having another online backup (besides my online drive).

It definitely is too much if you simple want to write a manuscript (msWord with Mendeley's plugin work great for reference managing), but I hate the idea of having multiple chapter 'x' versions files; and since I already use R for figures and tables it isn't too big a deal for me.

Hope this helps anyone. It certainly took some time to write :sweat_smile:.

PS: Unfortunately I could only include 2 links -.-.

Cheers,
Tom.

Thanks so much for the thoughtful and detailed response, @Tom1. Much appreciated. Lots to digest here, but happy to hear the thought process and technical challenges others have faced are similar to my own.

This topic was automatically closed 42 days after the last reply. New replies are no longer allowed.

If you have a query related to it or one of the replies, start a new topic and refer back with a link.