move example notebook to folder and add description to readme

zuzannna · Sep 23, 2018 · 1d644d9 · 1d644d9
1 parent cb864fb
commit 1d644d9
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -7,14 +7,18 @@ All you need to learn/teach basics of survival analysis. Presentation &amp; samp
 
 ## Example Notebooks 
 
-There are (?) notebooks containing more details on concepts that were touched on during the workshop. In order to run them, you need to have [Anaconda](https://docs.anaconda.com/anaconda/install/) (or [Miniconda](https://conda.io/docs/glossary.html#miniconda-glossary)) installed.
+There are 2 notebooks containing more details on concepts that were touched on during the workshop. In order to run them, you need to have [Anaconda](https://docs.anaconda.com/anaconda/install/) (or [Miniconda](https://conda.io/docs/glossary.html#miniconda-glossary)) installed.
 
 After that is done, you'll need to install the `lifelines` package:
 ```conda install -c conda-forge lifelines```
 
 The notebooks also use software for making visualizations, such as `seaborn`:
 ```conda install seaborn```
 
+### Survival Analysis Example
+
+The notebook [`SurvivalAnalysisExample.ipynb`](example_notebooks/SurvivalAnalysisExample.ipynb) introduces several standard computational methods in survival analysis that are used to determine the effect of diverse factors on survival. For example, the Cox Proportional Hazards model is used on sample data with the `lifelines` package in Python.
+
 ### Censored survival data
 
 The notebook [`censored_survival_data.ipynb`](example_notebooks/censored_survival_data.ipynb) illustrates the effect of having censored data, and why simply removing censored data is not the right thing to do.
diff --git a/SurvivalAnalysisExample.ipynb → ...e_notebooks/SurvivalAnalysisExample.ipynb b/SurvivalAnalysisExample.ipynb → ...e_notebooks/SurvivalAnalysisExample.ipynb
@@ -695,23 +695,23 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "dscrm-development_36",
+   "display_name": "Python 2",
    "language": "python",
-   "name": "dscrm-development_36"
+   "name": "python2"
   },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 3
+    "version": 2
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.6.0"
+   "pygments_lexer": "ipython2",
+   "version": "2.7.14"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 1
+ "nbformat_minor": 2
 }