Git Product home page Git Product logo

how-to-read-a-research-compendium's Introduction

How to Read a Research Compendium

"How to Read a Research Compendium" is published as a preprint on arXiv:

Nüst, Daniel, Carl Boettiger, and Ben Marwick. 2018. "How to read a research compendium." arXiv:1806.09525 [cs.GL].

A mobile friendly HTML5 version of the article can be accessed at https://ar5iv.org/html/1806.09525.

The manuscript is based on S. Keshav's "How to Read a Paper".

This "long-form" guide references numerous resources for technial details on research compendia, but itself is focussed on the full experience of interacting with a research compendium as a reader. If you want to apply the method presented in the paper, the Research Compendium Review Matrix will be useful.

Render the paper PDF locally

Rendering the PDF requires rticles to be installed from GitHub as the peerj article format is not yet on CRAN.

Locally with R:

  • Start an R session in the directory of this file
  • Run rmarkdown::render('how-to-read-a-research-compendium.Rmd')

Locally with a container: See the command used in .travis.yml.

Contributors

License

Creative Commons Attribution Share-Alike (CC BY-SA 4.0)

how-to-read-a-research-compendium's People

Contributors

nuest avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

how-to-read-a-research-compendium's Issues

Validate the approach

Process

The paper co-authors each read 2-3 research compendia using the guidelines. Papers read during the last 12 months are not allowed ;-). The lessons learned validate the process suggested in the How to.

Candidates

Should we add a "Related Work" section?

And what should it comprise? The original has something on writing reviews and writing articles/scientific writing.

One could also say the RC section is already enough related work.

Create community on Zenodo to list research compendia

Just like the GitHub tag (see #7) we could create a community on Zenodo to collect research compendia published on Zenodo.

Help needed

  • identifier
    • research-compendium 🥇
    • reproducible-paper
  • title
  • description
  • curation policy
    • require a corresponding journal submission?
    • require data + paper + code?
    • must have clear licenses
  • logo

Required information

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.