Merge pull request #100 from jvivian/jvivian/issue91

Clean-up for 1.0 release

README.md

@@ -23,14 +23,25 @@ Designed initially for evaluating the impacts of **COVID-19**, `DFMDash` is flex
 - **Dynamic Factor Models**: Build models that combine pandemic and economic series to estimate latent variables representing pandemic intensity.
 - **Drag-and-Drop**: Drop in files - options are then dynamically generated from the input data.
 
+
 ## Installation
-There are multiple ways to run `DFMDash`,
+There are multiple ways to install and run `DFMDash`.
+
+> **Note**: Due to PyPI constraints, the example data files are stored on the GitHub repository rather than in the pip-installed package. If you wish to use `DFMDash` with the provided example data, please clone the repository and follow the installation steps below.
 
 ### Prerequisites
 
 - Python 3.10+ is required.
 - Tested environments: **Ubuntu**, **WSL2 (Windows)**, **MacOS** (M1 compatible).
 
+### Option 0: Using Pip
+> **Advanced:** If you have a Python environment set up, prefer to install via `pip` and _do not_ want/need the example data.
+
+1. Install the package:
+   ```bash
+   pip install dfmdash
+   ```
+
 ### Option 1: Using Poetry
 
 0. [Install Poetry](https://python-poetry.org/)
@@ -175,3 +186,11 @@ For larger changes, please open an issue for discussion before submitting a PR.
 ## License
 
 `DFMDash` is distributed under the MIT License. See [LICENSE](./LICENSE) for details.
+
+
+# Citation
+> If you use this tool in your research, please cite the following paper
+
+```
+Cooke, A., & Vivian, J. (2024). Pandemic Intensity Estimation using Dynamic Factor Modelling. Statistics, Politics and Policy. Manuscript under review.
+```

coverage.xml

@@ -1,12 +1,12 @@
 <?xml version="1.0" ?>
-<coverage version="7.4.3" timestamp="1717638283749" lines-valid="319" lines-covered="306" line-rate="0.9592" branches-valid="96" branches-covered="82" branch-rate="0.8542" complexity="0">
+<coverage version="7.4.3" timestamp="1730151898557" lines-valid="319" lines-covered="302" line-rate="0.9467" branches-valid="96" branches-covered="82" branch-rate="0.8542" complexity="0">
 	<!-- Generated by coverage.py: https://coverage.readthedocs.io/en/7.4.3 -->
 	<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
 	<sources>
-		<source>/home/jvivian/covid19-drDFM/covid19_drdfm</source>
+		<source>/home/jvivian/covid19-drDFM/dfmdash</source>
 	</sources>
 	<packages>
-		<package name="." line-rate="0.9592" branch-rate="0.8542" complexity="0">
+		<package name="." line-rate="0.9467" branch-rate="0.8542" complexity="0">
 			<classes>
 				<class name="cli.py" filename="cli.py" complexity="0" line-rate="0.8857" branch-rate="0.5">
 					<methods/>
@@ -114,7 +114,7 @@
 						<line number="139" hits="1"/>
 					</lines>
 				</class>
-				<class name="dfm.py" filename="dfm.py" complexity="0" line-rate="0.9577" branch-rate="0.9">
+				<class name="dfm.py" filename="dfm.py" complexity="0" line-rate="0.9014" branch-rate="0.9">
 					<methods/>
 					<lines>
 						<line number="3" hits="1"/>
@@ -158,10 +158,10 @@
 						<line number="97" hits="1"/>
 						<line number="98" hits="1"/>
 						<line number="99" hits="1"/>
-						<line number="100" hits="1"/>
-						<line number="101" hits="1"/>
-						<line number="102" hits="1"/>
-						<line number="103" hits="1"/>
+						<line number="100" hits="0"/>
+						<line number="101" hits="0"/>
+						<line number="102" hits="0"/>
+						<line number="103" hits="0"/>
 						<line number="104" hits="1"/>
 						<line number="105" hits="1"/>
 						<line number="106" hits="1"/>