BLD: final touches (#20)

* DOC: change title of index * ENH: add cheatsheets * ENH: add license * DOC: update README * MAINT: republish * MAINT: change license
eigenfoo · Jun 27, 2019 · bbbeab6 · bbbeab6
1 parent 6f82f67
commit bbbeab6
Show file tree

Hide file tree

Showing 9 changed files with 839 additions and 389 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
diff --git a/Makefile b/Makefile
@@ -46,7 +46,7 @@ black:  # Format code in-place with black.
 publish:  # Run notebook in-place and generate HTML files.
 	jupyter nbconvert --to notebook --inplace --execute tests-as-linear.ipynb
 	jupyter nbconvert --to html tests-as-linear.ipynb
-	sh scripts/embed-clicky.sh
+	sh scripts/process-html.sh
 	rm tests-as-linear.html
 
 clean:  # Clean directory.

diff --git a/README.md b/README.md
@@ -26,8 +26,24 @@ please refer to the [original appendices
 upstream](https://github.com/lindeloev/tests-as-linear/tree/master/simulations)
 for the simulations.
 
+<div class="alert alert-warning">
+    Finally, certain statistical functions and tests are supported by neither
+    <code>statsmodels</code> or <code>scipy</code>, the two statistical Python
+    libraries used in this port. R code with no simple Python equivalent (mainly
+    in parts 6 and 7, <i>Three or more means</i> and <i>Proportions: Chi-square
+    is a log-linear model</i>) has not been ported. Such code has been noted in
+    yellow warning boxes such as this one.
+</div>
+
 ## Contributing
 
 Please refer to [the contributing
 guide](https://github.com/eigenfoo/tests-as-linear/blob/master/CONTRIBUTING.md)
 for project structure information and development instructions.
+
+## License
+
+This work is licensed under a Creative Commons Attribution 4.0 International
+License. Please refer to
+[`LICENSE.txt`](https://github.com/eigenoo/tests-as-linear/blob/master/LICENSE.txt)
+for more details.
diff --git a/cheatsheets/linear_tests_cheat_sheet.pages b/cheatsheets/linear_tests_cheat_sheet.pages
diff --git a/cheatsheets/linear_tests_cheat_sheet.pdf b/cheatsheets/linear_tests_cheat_sheet.pdf
diff --git a/cheatsheets/linear_tests_cheat_sheet.png b/cheatsheets/linear_tests_cheat_sheet.png
diff --git a/index.html b/index.html
diff --git a/scripts/embed-clicky.sh → scripts/process-html.sh b/scripts/embed-clicky.sh → scripts/process-html.sh
@@ -1,9 +1,12 @@
 #!/bin/bash
-# Embed Clicky web analytics to generated HTML files.
 
+# Embed Clicky web analytics.
 LINE=9
-
 head -n $LINE tests-as-linear.html > index.html
 echo '<script>var clicky_site_ids = clicky_site_ids || []; clicky_site_ids.push(101159456);</script>' >> index.html
 echo '<script async src="//static.getclicky.com/js"></script>' >> index.html
 tail -n +$LINE tests-as-linear.html >> index.html
+
+# Change title.
+sed -i.bak "s/<title>tests-as-linear<\/title>/<title>Common statistical tests are linear models (or: how to teach stats) | Eigenfoo<\/title>/" "index.html"
+rm index.html.bak
diff --git a/tests-as-linear.ipynb b/tests-as-linear.ipynb