4 ms·
This looks like a good reference for the fundamentals of both statistics and Julia, as claimed. I have a small critique, since the authors asked for suggestion
by jointpdf 7y ago
This looks like a good reference for the fundamentals of both statistics and Julia, as claimed. I have a small critique, since the authors asked for suggestions.
The format for the code samples goes like (code chunk —> output/plots —> bullet points explaining the code line-by-line). This creates a bit of a readability issue. The reader will likely follow a pattern like: (Skim past the code chunk to the explanation —> Read first bullet, referencing line X —> Go back to code to find line X, keeping the explanation in mental memory —> Read second bullet point —> ...). In other words, too much switching/scrolling between sections that can be pages apart. Look at the example on pages 185-187 to see what I mean.
I’m not sure what the optimal solution is. Adding comments in the code chunks themselves adds clutter and is probably worse (not to mention creates formatting nightmares). I think my favorite format is two columns, with the code on the left side and the explanations on the right.
Here’s what I have in mind (doesn’t work on mobile): https://allennlp.org/tutorials https://allennlp.org/tutorials. Does anyone know of a solution for formatting something like this?
- j88439h84 7y agoI'm not sure how that allennlp site is doing it, but source is here: https://github.com/allenai/allennlp/blob/b0ea7ab6be2787495fa52efd0f603659197c7d76/tutorials/tagger/basic_allennlp.py https://github.com/allenai/allennlp/blob/b0ea7ab6be2787495fa...
- j88439h84 7y agoHere's what they're doing: https://github.com/allenai/allennlp/blob/master/tutorials/tagger/convert.py https://github.com/allenai/allennlp/blob/master/tutorials/ta...
- psychometry 7y agoNot using PDF would be a good start. Bookdown texts tend to be good for mixed code/prose sections.
- jointpdf 7y agoYeah but PDF itself isn’t really the problem. Bookdown is nice, but if you’re using Bookdown then you’re using RMarkdown, so you can easily output the same .Rmd file as HTML/PDF/Reveal.js/EPub/etc. I’m trying to find well-executed examples or templates for what I have in mind (two column layout of code/text, maybe in landscape orientation for better spacing), but I’m drawing up blanks so far. Specifically I’m looking for either LaTeX or Reveal.js packages/templates for this.
- ynazarathy 7y agoThank you. Indeed not sure how to optimize it. Perhaps in the next version of the book. Note that the book is to be Springer published (once finished) - this puts some limitations as well. Happy for more feedback (Yoni Nazarathy).