A sketch for an article, contributions welcome!
"Ten simple rules..." articles are quite popular series of articles at PLOS. Find them all at https://collections.plos.org/ten-simple-rules or via Google Scholar.
As a sister-article to the preprint "How to Read a Research Compendium" (arXiv:1806.09525) targeting readers (and indirectly authors), this article supports authors in making sure their research compendium is soundly structured and composited.
As a side effect, it might be helpful for journals/editors who need to write author guidelines.
Questions and challenges:
- Is this possible to do across all domains, data types, and programming languages?
- How to relate to language or domain specific articles (that might be much more useful for authors), such as this one for R?
- Should Philip E. Bourne become a co-author?
And of course, regularly check if the manuscript is in line with "Ten Simple Rules for Writing a PLOS Ten Simple Rules Article".
The document is an R Markdown file best edited with RStudio.
You can render an HTML preview in R with
rmarkdown::render("manuscript.Rmd")Contributions are more than welcome, they are much needed! This article can only "fly" if it has valuable content, is witty and well-written, and builds upon wide experience - none of which is possible without collaboration.
You can start by checking out the current draft in manuscript.Rmd, see if there are issues to reply to or, even better, to solve, or have a go at the "challenges and questions" above.
If you want to update the manuscript file, please fork this repository, make your changes, and send a pull request to the master branch.
This manuscript is published and contributions fall under a Creative Commons Attribution 4.0 International (CC BY 4.0) license.
