How to write a README

When collecting data, essential information on datasets, such as how variables were measured or how missing values were handled, is often only recorded in field notebooks or a researcher’s memory, and it can be easily lost over time. Good documentation makes it easier for others (and you!) to understand the dataset. One important way to document data is through a README file. A README is … Continue reading How to write a README

Policy on Publishing Code: Encouraging Good Practice to Ensure Quality

Following on from our sponsorship of the Guide to Reproducible Code in Ecology and Evolution and our collaboration with rOpenSci, we have now released a new policy on publishing code. The main objective of this policy is to make sure that high quality code is readily available to our readers.

We’ve set out four key principles to help achieve this, as well as explaining what code outputs we publish, giving some examples of things that make it easier to review code, and giving some advice on how to store code once it’s been published. Below is a summary of some highlights of the policy, but you can find it in full on the Methods in Ecology and Evolution website. Continue reading “Policy on Publishing Code: Encouraging Good Practice to Ensure Quality”