Git Product home page Git Product logo

msmbstyle's Introduction

msmbstyle

The msmbstyle package provides an alternative design for HTML books produced using the R package bookdown. The layout was developed to closely match an existing publication produced using Sweave and LaTeX. The general structure is heavily influenced by the handout design of Edward Tufte, with figures and annotations appearing in the margin alongside the main text, and much of the document conversion/creation is actually carried out by the tufte package. msmbstyle provides some additional modifications to the overall layout of the book.

You can view a simple example of the HTML produced by msmbstyle at https://www-huber.embl.de/users/msmith/msmbstyle/, and the R Markdown documents used to generate this are present in the /inst/extdata/ folder of this package

A example of a complete book generated using msmbstyle can be found at Modern Statistics for Modern Biology by S. Holmes & W. Huber.

msmbstyle vs tufte styling

A (probably incomplete) list of the layout differences between an HTML book produced by msmbstyle and the default options in tufte:

  • Book title and author names listed in a header bar at the top of each page.
  • Document navigation provided by drop-down menu in the top right of each page.
    • One entry per chapter.
    • The current chapter has sections listed too.
  • Sans serif font for the main text (currently using Source Sans Pro)
  • Defines additional document sections (currently Questions & Solutions) that can be referenced in text, and have their visibility toggled within the final document
  • Keeps default width of code blocks when vertically aligned with margin figures.
  • Provides CSS support to place tables in the margin along with figures and notes.

Alternate branches

The grid-layout branch uses Bootstrap to provide an alternative approach to arranging the content into columns. An example can be seen at https://www.huber.embl.de/users/msmith/msmbstyle/bootstrap/

Acknowledgments

Funding

Funding for development of this package and the surrounding efforts directed towards the creation of the online version of Modern Statistics for Modern Biology is provided by the German Network for Bioinformatics Infrastructure

msmbstyle's People

Contributors

grimbough avatar lgatto 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.