Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
robitalec committed Apr 21, 2020
1 parent 345a979 commit 511fcc4
Showing 1 changed file with 47 additions and 27 deletions.
74 changes: 47 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@

study-area-figures
==================
# study-area-figures

Collecting WEEL study area figures in one place, for sharing!
Collecting WEEL study area figures in one place, for sharing\!

Contributing:
-------------
## Contributing:

1. Clone the repository
2. Add your script (follow the numbering scheme)
3. Add the output figure to `graphics/`, with a name and number matching the script it originates from.
4. (Ideally) add the figure to the `README.Rmd` so we can preview them all together in one spot.
3. Add the output figure to `graphics/`, with a name and number
matching the script it originates from.
4. (Ideally) add the figure to the `README.Rmd` so we can preview them
all together in one spot.

**Note: currently the input folder is ignored, if you have small data you'd like to share, carefully remove it from the `.gitignore`**
**Note: currently the input folder is ignored, if you have small data
you’d like to share, carefully remove it from the `.gitignore`**

Also, we output the features to `.gpkg` (GeoPackage) because... [shapefiles are hell](http://switchfromshapefile.org).
Also, we output the features to `.gpkg` (GeoPackage) because…
[shapefiles are hell](http://switchfromshapefile.org).

Also\! I made a bash script for rerunning all the figures. If you want
to try it, let me know.
Expand All @@ -23,71 +25,89 @@ to try it, let me know.

1. Fogo Island

This uses data from Open Street Map and four packages: `osmdata`, `sf`, `data.table` and `ggplot`.
This uses data from Open Street Map and four packages: `osmdata`, `sf`,
`data.table` and `ggplot`.

Reproducing: run `01-fogo-island-prep.R` to generate the islands polygon and `02-fogo-island-figure.R` to generate the figure.
Reproducing: run `01-fogo-island-prep.R` to generate the islands polygon
and `02-fogo-island-figure.R` to generate the figure.

``` r
knitr::include_graphics('graphics/02-fogo-island.png')
```

<img src="graphics/02-fogo-island.png" width="3200" />

1. Newfoundland
2. Newfoundland

This uses data from Open Street Map and four packages: `osmdata`, `sf`, `data.table` and `ggplot`.
This uses data from Open Street Map and four packages: `osmdata`, `sf`,
`data.table` and `ggplot`.

Reproducing: run `03-newfoundland-prep.R` to generate the islands polygon and `04-newfoundland-figure.R` to generate the figure.
Reproducing: run `03-newfoundland-prep.R` to generate the islands
polygon and `04-newfoundland-figure.R` to generate the figure.

Note: this map doesn't show internal water. Let me know if that's something you'd like to add.
Note: this map doesn’t show internal water. Let me know if that’s
something you’d like to add.

``` r
knitr::include_graphics('graphics/04-newfoundland.png')
```

<img src="graphics/04-newfoundland.png" width="2240" />

1. Fogo with Newfoundland inset
3. Fogo with Newfoundland inset

This uses data from Open Street Map and four packages: `osmdata`, `sf`, `data.table` and `ggplot`.
This uses data from Open Street Map and four packages: `osmdata`, `sf`,
`data.table` and `ggplot`.

Reproducing: run `01-fogo-island-prep.R`, `03-newfoundland-prep.R`, to generate the Fogo and NL polygons and `04-fogo-inset-newfoundland-figure.R` to combine and generate the figure.
Reproducing: run `01-fogo-island-prep.R`, `03-newfoundland-prep.R`, to
generate the Fogo and NL polygons and
`04-fogo-inset-newfoundland-figure.R` to combine and generate the
figure.

``` r
knitr::include_graphics('graphics/05-fogo-inset-nl.png')
```

<img src="graphics/05-fogo-inset-nl.png" width="2240" />

1. Terra Nova
4. Terra Nova

This uses data from GeoGratis and Open Street Map and six packages: `osmdata`, `curl`, `zip`, `sf`, `data.table` and `ggplot`.
This uses data from GeoGratis and Open Street Map and six packages:
`osmdata`, `curl`, `zip`, `sf`, `data.table` and `ggplot`.

Reproducing: run `03-newfoundland-prep.R` and `06-terra-nova-prep.R` to generate the NL and TN polygons and `07-terra-nova-figure.R` to combine and generate the figure.
Reproducing: run `03-newfoundland-prep.R` and `06-terra-nova-prep.R` to
generate the NL and TN polygons and `07-terra-nova-figure.R` to combine
and generate the figure.

``` r
knitr::include_graphics('graphics/07-terra-nova.png')
```

<img src="graphics/07-terra-nova.png" width="3200" />

1. Terra Nova Bunny Grids
5. Terra Nova Bunny Grids

This uses data from GeoGratis and Open Street Map and six packages: `osmdata`, `curl`, `zip`, `sf`, `data.table` and `ggplot`.
This uses data from GeoGratis and Open Street Map and six packages:
`osmdata`, `curl`, `zip`, `sf`, `data.table` and `ggplot`.

Reproducing: run `03-newfoundland-prep.R` and `06-terra-nova-prep.R` to generate the NL and TN polygons and `08-terra-nova-buns-figure.R` to combine and generate the figure.
Reproducing: run `03-newfoundland-prep.R` and `06-terra-nova-prep.R` to
generate the NL and TN polygons and `08-terra-nova-buns-figure.R` to
combine and generate the figure.

``` r
knitr::include_graphics('graphics/08-terra-nova-buns.png')
```

<img src="graphics/08-terra-nova-buns.png" width="3200" />

1. Bloomfield
6. Bloomfield

This uses data from Open Street Map and six packages: `osmdata`, `curl`, `zip`, `sf`, `data.table` and `ggplot`.
This uses data from Open Street Map and six packages: `osmdata`, `curl`,
`zip`, `sf`, `data.table` and `ggplot`.

Reproducing: run `03-newfoundland-prep.R` and `06-terra-nova-prep.R` to generate the NL and TN polygons and `09-bloomfield-figure.R` to combine and generate the figure.
Reproducing: run `03-newfoundland-prep.R` and `06-terra-nova-prep.R` to
generate the NL and TN polygons and `09-bloomfield-figure.R` to combine
and generate the figure.

``` r
knitr::include_graphics('graphics/09-bloomfield.png')
Expand Down

0 comments on commit 511fcc4

Please sign in to comment.