Skip to content
Tufte inspired bookdown template
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R Added function imports to NAMESPACE May 21, 2019
inst Explicitly set code overflow to scrolling May 17, 2019
DESCRIPTION Better alignment of margin tables with code blocks May 20, 2019
NAMESPACE Added function imports to NAMESPACE May 21, 2019
README.md typo Oct 14, 2018
msmbstyle.Rproj Initial commit Aug 2, 2018

README.md

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

You can’t perform that action at this time.