Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup/consistency list #25

Open
36 of 38 tasks
m-clark opened this issue Dec 10, 2023 · 0 comments
Open
36 of 38 tasks

Cleanup/consistency list #25

m-clark opened this issue Dec 10, 2023 · 0 comments
Assignees

Comments

@m-clark
Copy link
Owner

m-clark commented Dec 10, 2023

Bigger changes

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 when possible (e.g. not one with and without some features)
  • add statistical detail to dataset descriptions

Potential Content Trimming

  • Merge overlapping content
    • 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
  • Could remove what amounts to a demo chapter in the intro
  • Could remove some appendix content (matrix, nix simulation, bayes)
  • Drop some deeper code examples (e.g. estimation beyond the estimation chapter may need to be nixed for length. Just comment out.
  • 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 (title case tables and plots)
  • 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?
  • 'Part' placement in pdf TOC quarto-dev/quarto-cli#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
  • Change out \newpage with {{< pagebreak >}}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants