CfSOtago / energyPAPs

A place to record your energy ‘Pre-Analysis Plans’ (protocols)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Energy ‘Pre-Analysis Plans’ (PAPs)

You probably came for -> The big list of energy study PAPs.

Inspired by:

What are we trying to do?

We are trying to provide an open space for the documentation and publication of "analysis plans which outline what the key outcome measures are and a step-by-step outline of how the analysis will be conducted, including what covariates and statistical tests will be employed to estimate treatment effects, how missing data will be handled and how key variables will be coded" (Huebner et al, 2017).

Huebner et al (and other authors) refer to these as pre-analysis plans, in the health sciences they are often termed protocols. Either way they are crucial to enabling replicability of research findings, guarding against suppression of 'null' results and preventing p-value fishing. On this and other evil practices see Sovacool et al.

Whilst the publication of 'protocols' as peer-reviewed papers is common practice in some areas of science, this is not currently the case with energy studies. This repo is an attempt to kick-start this process.

How to contribute

If you have designed and run an energy study please:

  • fork the repo;
  • use the PAP template to record relevant details about your study. This is not a form, it's a template. Use it flexibly but informatively. You might find some of the existing PAPs can help with hints, phrases and methods. If you have already completed study documentation for a data archive (e,g, for the UK Data Service) then just re-use it with any necessary additions. We expect the template to evolve over time;
  • save your entry as a new PAP.md file
  • add an entry to the big list of studies
  • git commit your changes
  • send us a git pull request

We will then quickly review your addition for completeness and add it to the repo. We may also ask for further details...

If all of this is way beyond your github comfort zone then do not panic, ask a friendly grad student. Or you could simply edit the repo directly online. This will require a github account as it goes through the same edit -> commit -> pull request process.

However you don't need to have designed a study to contribute. You can also comment, or raise an issue on an existing entry - to ask for further details for example.

Rules for contributing

See the contributing guidelines.

About

A place to record your energy ‘Pre-Analysis Plans’ (protocols)

License:MIT License