Updated IV vignette and added to website structure

Author: andrewherren

.github/workflows/docs.yml

@@ -100,12 +100,15 @@ jobs:
 
       - name: Copy static vignettes over to docs directory
         run: |
-          cp vignettes/Python/rdd.html docs/vignettes/Python/rdd.html
-          cp vignettes/Python/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
-          cp vignettes/Python/trees1.png docs/vignettes/Python/trees1.png
-          cp vignettes/Python/trees2.png docs/vignettes/Python/trees2.png
-          cp vignettes/Python/trees3.png docs/vignettes/Python/trees3.png
-          cp vignettes/R/rdd.html docs/vignettes/R/rdd.html
+          cp vignettes/Python/RDD/rdd.html docs/vignettes/Python/rdd.html
+          cp vignettes/Python/RDD/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
+          cp vignettes/Python/RDD/trees1.png docs/vignettes/Python/trees1.png
+          cp vignettes/Python/RDD/trees2.png docs/vignettes/Python/trees2.png
+          cp vignettes/Python/RDD/trees3.png docs/vignettes/Python/trees3.png
+          cp vignettes/R/RDD/rdd.html docs/vignettes/R/rdd.html
+          cp vignettes/Python/IV/iv.html docs/vignettes/Python/iv.html
+          cp vignettes/Python/IV/IV_CDAG.png docs/vignettes/Python/IV_CDAG.png
+          cp vignettes/R/IV/iv.html docs/vignettes/R/IV/iv.html
       
       - name: Build the overall doc site
         run: |

README.md

@@ -102,12 +102,15 @@ cp stochtree_repo/demo/notebooks/prototype_interface.ipynb docs/python_docs/demo
 ### Copy static vignettes over to docs directory
 
 ```{bash}
-cp vignettes/Python/rdd.html docs/vignettes/Python/rdd.html
-cp vignettes/Python/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
-cp vignettes/Python/trees1.png docs/vignettes/Python/trees1.png
-cp vignettes/Python/trees2.png docs/vignettes/Python/trees2.png
-cp vignettes/Python/trees3.png docs/vignettes/Python/trees3.png
-cp vignettes/R/rdd.html docs/vignettes/R/rdd.html
+cp vignettes/Python/RDD/rdd.html docs/vignettes/Python/rdd.html
+cp vignettes/Python/RDD/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
+cp vignettes/Python/RDD/trees1.png docs/vignettes/Python/trees1.png
+cp vignettes/Python/RDD/trees2.png docs/vignettes/Python/trees2.png
+cp vignettes/Python/RDD/trees3.png docs/vignettes/Python/trees3.png
+cp vignettes/R/RDD/rdd.html docs/vignettes/R/rdd.html
+cp vignettes/Python/IV/iv.html docs/vignettes/Python/iv.html
+cp vignettes/Python/IV/IV_CDAG.png docs/vignettes/Python/IV_CDAG.png
+cp vignettes/R/IV/iv.html docs/vignettes/R/IV/iv.html
 ```
 
 ### Building the overall website

dev/build.sh

@@ -44,12 +44,15 @@ cp stochtree_repo/demo/notebooks/tree_inspection.ipynb docs/python_docs/demo/tre
 cp stochtree_repo/demo/notebooks/prototype_interface.ipynb docs/python_docs/demo/prototype_interface.ipynb
 
 # Copy static vignettes over to docs directory
-cp vignettes/Python/rdd.html docs/vignettes/Python/rdd.html
-cp vignettes/Python/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
-cp vignettes/Python/trees1.png docs/vignettes/Python/trees1.png
-cp vignettes/Python/trees2.png docs/vignettes/Python/trees2.png
-cp vignettes/Python/trees3.png docs/vignettes/Python/trees3.png
-cp vignettes/R/rdd.html docs/vignettes/R/rdd.html
+cp vignettes/Python/RDD/rdd.html docs/vignettes/Python/rdd.html
+cp vignettes/Python/RDD/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
+cp vignettes/Python/RDD/trees1.png docs/vignettes/Python/trees1.png
+cp vignettes/Python/RDD/trees2.png docs/vignettes/Python/trees2.png
+cp vignettes/Python/RDD/trees3.png docs/vignettes/Python/trees3.png
+cp vignettes/R/RDD/rdd.html docs/vignettes/R/rdd.html
+cp vignettes/Python/IV/iv.html docs/vignettes/Python/iv.html
+cp vignettes/Python/IV/IV_CDAG.png docs/vignettes/Python/IV_CDAG.png
+cp vignettes/R/IV/iv.html docs/vignettes/R/IV/iv.html
 
 # Build the doc site
 mkdocs build

docs/vignettes/index.md

@@ -9,3 +9,4 @@ with an R and Python version for each vignette.
 Current advanced vignettes include:
 
 1. Using `stochtree` for Regression Discontinuity Design ([R](R/rdd.html), [Python](Python/rdd.html))
+2. Using `stochtree` for Instrumental Variables Analysis ([R](R/iv.html), [Python](Python/iv.html))

mkdocs.yml

@@ -72,8 +72,10 @@ nav:
   - 'Vignettes':
     - 'Vignettes': vignettes/index.md
     - 'R':
+      - 'Instrumental Variables': 'vignettes/R/IV/iv.html'
       - 'RDD': 'vignettes/R/RDD/rdd.html'
     - 'Python': 
+      - 'Instrumental Variables': 'vignettes/Python/IV/iv.html'
       - 'RDD': 'vignettes/Python/RDD/rdd.html'
   - 'Development': 
     - 'Development': development/index.md