ropensci / unconf16

rOpenSci's San Francisco hackathon/unconf 2016
http://unconf16.ropensci.org
24 stars 7 forks source link

lesson template package #39

Open tracykteal opened 8 years ago

tracykteal commented 8 years ago

For all the people writing lessons, it might be nice if there was a lesson template package. @karthik hacked one together quickly a while ago:
https://github.com/karthik/dcTemplate

and I tried it here: http://tracykteal.github.io/test-workshop-template/template-test.html

but it could look more something more like:
http://karthik.github.io/template/

If we got the general outline together, we could modify the exact look and feel later.

tracykteal commented 8 years ago

We could also add Travis-CI support so that Rmd lesson files committed to a repo would be automatically knit. @fmichonneau did a test run of that here http://github.com/fmichonneau/test-travis-dc

tracykteal commented 8 years ago

An idea would be to adapt the Tufte package for lessons http://rstudio.github.io/tufte/

tracykteal commented 8 years ago

We also are looking at bookdown

https://bookdown.org

RMHogervorst commented 8 years ago

I'd be interested in this idea,

what would be the scope of that package? A general same feel of pages?

Or more like placeholders : Add goals here

add a few keypoints

etc

fmichonneau commented 8 years ago

Following the slack thread, we may want to look into lens as well: https://github.com/elifesciences/lens

karthik commented 8 years ago

Lens is not a good idea for this context. It just adds so much overhead to something that needs to be simple, readable document with rendered text and code. We barely have time to maintain and template lessons. Do we really want to troubleshoot node and possibly json/xml parsing issues?

fmichonneau commented 8 years ago

Oh I see... I hadn't looked into how it was implemented. I agree, there is too much overhead.