Skip to content

Commit

Permalink
Fix broken links in readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
rlskoeser committed May 7, 2024
1 parent 9a54fa9 commit c1b4a06
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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:

Expand All @@ -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.

2 changes: 1 addition & 1 deletion data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions missing_data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit c1b4a06

Please sign in to comment.