Git Product home page Git Product logo

intro-research-compendia's Introduction

How and Why to Make a Research Compendium

Dr. Max Joseph

DOI

What's in here:

docs/

Source code for slides from the Earth Lab webinar on 2020-03-19. These can be viewed at https://mbjoseph.github.io/intro-research-compendia/

example-compendium/

An example compendium that looks at Denver traffic in 2020. The output of this compendium is a pdf report report.pdf, available at: https://drive.google.com/file/d/197Oqu08lo2JEM2NyIbLNDJtnlcjGAA2B/view?usp=sharing

This is a simple example, designed to demonstrate:

  • Using logical directory structure
  • Setting rules for re-use with a LICENSE
  • Separation of input and output
  • Specification of a computational environment
  • Coordination of multiple steps using GNU Make
  • Generation of a paper or report using pandoc

An overview of the workflow is provided below:

intro-research-compendia's People

Contributors

mbjoseph avatar

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.