Giter VIP home page Giter VIP logo

rmd4sci's Introduction

Netlify StatusProject Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Travis build status

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.

Rmarkdown for Scientists

This is a book on rmarkdown, aimed for scientists. It was initially developed as a 3 hour workshop, but is now developed into a resource that will grow and change over time as a living book.

This book aims to teach the following:

  • Getting started with your own R Markdown document
  • Improve workflow:
    • With rstudio projects
    • Using keyboard shortcuts
  • Export your R Markdown document to PDF, HTML, and Microsoft Word
  • Better manage figures and tables
    • Reference figures and tables in text so that they dynamically update
    • Create captions for figures and tables
    • Change the size and type of figures
    • Save the figures to disk when creating an rmarkdown document
  • Work with equations
    • inline and display
    • caption equations
    • reference equations
  • Manage bibliographies
    • Cite articles in text
    • generate bibliographies
    • Change bibliography styles
  • Debug and handle common errors with rmarkdown
  • Next steps in working with rmarkdown - how to extend yourself to other rmarkdown formats

Abstract aka "why should you read this"

For a scientific report to be completely credible, it must be reproducible. The full computational environment used to derive the results, including the data and code used for statistical analysis should be available for others to reproduce. R Markdown is a tool that allows you integrate your code, text and figures in a single file in order to make high quality, reproducible reports. A paper published with an included R Markdown file and data sets can be reproduced by anyone with a computer.

After completing this course, you will know how to:

  • Create your own R Markdown document
  • Create figures and tables that you can reference in text, and update with - your data
  • Export your R Markdown document to PDF, HTML, and Microsoft Word
  • Use keyboard shortcuts to improve workflow
  • Cite research articles and generate a bibliography We may, depending on time, also cover the following areas:
  • Change the size and type of your figures
  • Create captions for your figures, and reference them in text
  • Cite research articles and generate a bibliography
  • Debug and handle common errors

License

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.

rmd4sci's People

Contributors

adamhsparks avatar apreshill avatar bikramhalder avatar federicomarini avatar imgbotapp avatar murraycadzow avatar njtierney avatar robjhyndman avatar xiruizhao 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  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  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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

rmd4sci's Issues

misc details to possibly include at a later date

Things generated from the rmarkdown output:

  • _files/
  • _cache/

The compile order of a rmarkdown document

Features like tabsetting in HTML docs

Unanswered questions

There are also some questions that I posed in the book that I haven't quite answered, but I think are valid, but time consuming to answer in full

Why should I use Rmarkdown? I already use (scientific word, Microsoft Word, LaTeX, Word Perfect), and this works fine for me.

Should I write my whole paper in Rmarkdown?

Yes, you should. It might look weird, and not the same as a word doc, but being able to go from start to finish and reproduce this 6 months down the track is a big deal.

How to add "demo" sections

I'm currently using .demo like so:

## Demo {.demo}

But It would be nice if I could have a different span, like:

\demo{

..content..

}

licence appears 2x

The licence appears once in the index as a section and again as a chapter.

PDF issues

  • Fixing the section numbering (currently when I render the PDF it is all front matter, which means that I get to see the roman numerals go from i to lxxii.

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.