Skip to content

Commit

Permalink
Update readme ahead of release
Browse files Browse the repository at this point in the history
  • Loading branch information
qdread committed Dec 2, 2021
1 parent d5e928d commit 4ae31b0
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,36 @@
# DasyPop
# DasyPop: A Dasymetric Population Map Based on US Census Data and 30-m Gridded Estimates of Impervious Surface

This code repository will accompany a publication in *Scientific Data*.
This code repository accompanies a dataset and article published in *Scientific Data*.

**Insert citation and DOI here when available**
Authors:

- Rachel Swanwick (SESYNC; University of Vermont)
- Quentin D. Read (SESYNC; USDA Agricultural Research Service)
- Steven Guinn (UMCES IAN)
- Matt Williamson (Boise State University)
- Kelly L. Hondula (SESYNC; Battelle, National Ecological Observatory Network)
- Andrew Elmore (UMCES; SESYNC)

## Contents

The code is in three Markdown notebooks:
The code is in three Markdown notebooks containing a combination of R code and Bash commands:

- `dasypop_methods.md`: the code to generate dasymetric population estimates by county
- `validation_figure.md`: uses the estimates generated in the previous notebook and compares their performancem against other existing estimates using flood and wildfire risk data
- `validation_figure.md`: uses the estimates generated in the previous notebook and compares their performance against other existing estimates using flood and wildfire risk data
- `methods_figure.md`: generates a figure illustrating the estimation process

## How to run

See the individual notebooks for instructions on how to run the code and download the necessary external data. The code in the `dasypop_methods.md` notebook should be run first.

*Last updated by QDR, 25 October 2021*
## Recommended citation

### Code

Swanwick, R. H., Q. D. Read, S. Guinn, M. Williamson, K. L. Hondula, and A. Elmore. 2021. Code accompanying "DasyPop: A Dasymetric Population Map Based on US Census Data and 30-m Gridded Estimates of Impervious Surface."

### Dataset and article

Citation will be included here when the dataset and article are accepted for publication.

*Last updated by QDR, 02 December 2021*

0 comments on commit 4ae31b0

Please sign in to comment.