From c1b4a069eaf09384d5f92839e8251d9f689a3766 Mon Sep 17 00:00:00 2001 From: rlskoeser Date: Tue, 7 May 2024 15:19:44 -0400 Subject: [PATCH] Fix broken links in readme files --- README.md | 7 ++++--- data/README.md | 2 +- missing_data/README.md | 4 ++-- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e54b2bf..4126836 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ This repository provides replication code and data for **Missing Data, Speculati - [missing_data](missing_data) - code notebooks for the missing data portion of the article - [speculative_reading](speculative_reading) - code notebooks for the speculative reading portion of the article - [appendix](appendix) - additional notebooks with validation, alternate approaches, etc; work that did not make it into the article -- [figures][figures] - exported versions of figures for the article generated by code in multiple formats where supported -- [utils][utils] - utility python code used by multiple notebooks +- [figures](figures) - exported versions of figures for the article generated by code in multiple formats where supported +- [utils](utils) - utility python code used by multiple notebooks ## Installing dependencies and running code @@ -23,6 +23,8 @@ a python virtual environment. Dependencies can be installed with pip: pip install -r requirements.lock ``` +### Testing + There are unit tests for some utility code, which include checks that data files are available at the expected locations. To run them, install and run pytest: @@ -36,4 +38,3 @@ They are intended to be run locally, with dependencies installed. We use [treon](https://github.com/ReviewNB/treon) (`pip install treon`) to confirm that Jupyter notebooks execute without errors. - diff --git a/data/README.md b/data/README.md index cb4c609..c133e82 100644 --- a/data/README.md +++ b/data/README.md @@ -28,7 +28,7 @@ an inventory from the Sylvia Beach papers. Members with extant but incomplete borrowing records. CSV files list these members and their subscriptions without documented borrowing activity. The collapsed version consolidates sequential or near-sequential subscriptions. -The files were generated by [identify_partial_borrowers.py](../speculative-reading/identify_partial_borrowers.py) +The files were generated by [identify_partial_borrowers.py](../speculative_reading/identify_partial_borrowers.py) - partial_borrowers.csv - partial_borrowers_collapsed.csv diff --git a/missing_data/README.md b/missing_data/README.md index 303a5c6..c07c318 100644 --- a/missing_data/README.md +++ b/missing_data/README.md @@ -17,6 +17,6 @@ This folder includes code used for the estimates in the "Missing Data" section o ### Archived Notebooks -- [Sco_prophet_missingdata_weekly.ipynb](Sco_prophet_missingdata_weekly.ipynb) — calculates logbook gaps; uses Prophet to generate estimates for missing membership events, missing members -- [ScoBorrowingCapacity_v1_1data.ipynb](ScoBorrowingCapacity_v1_1data.ipynb) — borrowing capacity analysis; used as basis for estimating missing borrowing activity +- [Sco_prophet_missingdata_weekly.ipynb](archived_notebooks/Sco_prophet_missingdata_weekly.ipynb) — calculates logbook gaps; uses Prophet to generate estimates for missing membership events, missing members +- [ScoBorrowingCapacity_v1_1data.ipynb](archived_notebooks/ScoBorrowingCapacity_v1_1data.ipynb) — borrowing capacity analysis; used as basis for estimating missing borrowing activity