book-of-models icon indicating copy to clipboard operation
book-of-models copied to clipboard

Cleanup/consistency list

Open m-clark opened this issue 6 months ago • 0 comments

Bigger changes

  • [ ] All chapters should have key ideas, why this matters, good to know, where to go, wrapping up sections (and exercises if appropriate); reference per chapter to be determined (#17)
  • [ ] All chapters/sections (at least level 2) need to be linkable and linked throughout the text
  • [ ] Add content to preface/acknowledgments/misc models
  • [x] #19
  • [ ] Spelling/typo checks

Data

  • [ ] Data needs to be linked. Possibly early on like even in preface.
  • [ ] There should be only one version of a single data source being used (e.g. not one with and without some features)

Potential Content Trimming

  • [ ] Merge overlapping content
    • [x] LM and model exploration chapter
    • [ ] Data, and ML other models chap, and misc models chap
  • [ ] ML concepts gets pretty deep, could trim a lot there
  • [x] Could remove what amounts to a demo chapter in the intro
  • [ ] Could remove some appendix content (matrix, nix simulation, bayes)
  • [x] Drop some deeper code examples (e.g. estimation beyond the estimation chapter may need to be nixed for length. Just comment out.
  • [X] LM Part needs consistency update

Code

  • [ ] code needs to be cleaned/made consistent between SB and MC
    • R:
    • [ ] No <- assignment for R code
    • [ ] 4 space indent?
    • Py:
    • [ ] uglify to Pep standards
    • [ ] Other?
    • General:
    • [ ] No more than 80 char for pdf
    • [ ] !! Make sure the printed code runs as is !!

Tables & Figures

  • [ ] Make sure all figures and tables are linkable/cross-referenceable
  • [ ] Make sure no labels have underscores (latex can't handle it)
  • [ ] Make sure no gt tables use color (latex can't handle it)

Other that needs to be done

  • [ ] Add simulation demo/discussion if space permits
  • [ ] Chapter title/section casing (use css if possible)
  • [ ] Dataset descriptions
  • [ ] bold should be key words, italics just for emphasis
  • [ ] Save out figures as separate files if not already. Preferably svg.
  • [ ] Move programming discussion in ML to a general one in Part 3 or appendix. Trim discussion in intro?
  • [x] https://github.com/quarto-dev/quarto-cli/issues/7856
  • [ ] Fix missing crossref

Lesser issues

  • [ ] Want to remove chapter specific folders. keep everything in just data, img.
  • [ ] All the graphical models need separate dot files and looks the same
  • [ ] All chunks should be named

m-clark avatar Dec 10 '23 20:12 m-clark