small fixes to full doc example and paper

ronikobrosly · Jul 5, 2020 · 13afa12 · 13afa12
1 parent 98a2759
commit 13afa12
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 11 deletions.
diff --git a/docs/full_example.rst b/docs/full_example.rst
@@ -4,15 +4,16 @@
 Health data: generating causal curves and examining mediation
 =============================================================
 
-The causal effect of blood lead levels on cognitive performance in children
----------------------------------------------------------------------------
-
 To provide an end-to-end example of the sorts of analyses `cause-curve` can be used for, we'll
-begin with an epidemiology topic. A notebook containing the pipeline to produce the following
+begin with a health topic. A notebook containing the pipeline to produce the following
 output `is available here <https://github.com/ronikobrosly/causal-curve/blob/master/examples/NHANES_BLL_example.ipynb>`_.
 Note: Specific examples of the individual `causal-curve` tools with
 code are available elsewhere in this documentation.
 
+
+The causal effect of blood lead levels on cognitive performance in children
+---------------------------------------------------------------------------
+
 Despite the banning of the use of lead-based paint and the use of lead in gasoline in the United
 States, lead exposure remains an enormous public health problem for children and adolescents. This
 is particularly true for poorer children living in older homes in inner-city environments.
@@ -105,7 +106,7 @@ we found that the overall, mediating indirect effect of BLLs are 0.20 (0.17 - 0.
 that lead exposure accounts for 20% of the relationship between low income and low test
 performance in this population. The mediation tool also allows you to see how the indirect effect
 varies as a function of the treatment. As the plot shows, the mediating effect is relatively flat,
-although interesting there is a hint of an increase as income increases relative to the povetry line.
+although interesting there is a hint of an increase as income increases relative to the poverty line.
 
 .. image:: ../imgs/full_example/mediation_curve.png
 

diff --git a/examples/NHANES_BLL_example.ipynb b/examples/NHANES_BLL_example.ipynb
diff --git a/imgs/full_example/mediation_curve.png b/imgs/full_example/mediation_curve.png
diff --git a/paper/paper.md b/paper/paper.md
@@ -101,7 +101,7 @@ potential outcomes / counterfactual framework [@Imai:2010]. While this approach
 continuous mediator and outcome, as put forward by Imai it only allows for a binary treatment. As
 mentioned above with the `TMLE` approach, the tool creates a series of binary treatment comparisons
 and connects them to show the user how mediation varies as a function of the treatment. An interpretable,
-overall mediation percentage is provided as well.
+overall mediation proportion is provided as well.
 
 
 # Statement of Need
@@ -116,7 +116,7 @@ and are instructive as to how the results of their analysis should be interprett
 
 # Acknowledgements
 
-We acknowledge contributions from Miguel-Angel Luque, Erica Moodie, and Mark van der Laan
+We acknowledge the valuable feedback from Miguel-Angel Luque, Erica Moodie, and Mark van der Laan
 during the creation of this project.