diff --git a/README.Rmd b/README.Rmd index 79aee5f..9fc4319 100644 --- a/README.Rmd +++ b/README.Rmd @@ -38,6 +38,21 @@ Install the development version from [GitHub](https://github.com/) with: remotes::install_github("itsleeds/slopes") ``` +If you do not already have DEM data and want to make use of the package's ability to download them using the `ceramic` package, install the package with suggested dependencies as follows: + +```{r, eval=FALSE} +# install.packages("remotes") +remotes::install_github("itsleeds/slopes", dependencies = "Suggests") +``` + +Furthermore, you will need to add a MapBox API key to be able to get DEM datasets, by signing up and registering for a key at https://account.mapbox.com/access-tokens/ and then following these steps: + +```{r, eval=FALSE} +usethis::edit_r_environ() +# Type in (register on the mapbox website): +MAPBOX_API_KEY=xxxxx +``` + ## Usage Load the package in the usual way: diff --git a/README.md b/README.md index a5a47c5..bdc41f9 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,26 @@ Install the development version from [GitHub](https://github.com/) with: remotes::install_github("itsleeds/slopes") ``` +If you do not already have DEM data and want to make use of the +package’s ability to download them using the `ceramic` package, install +the package with suggested dependencies as follows: + +``` r +# install.packages("remotes") +remotes::install_github("itsleeds/slopes", dependencies = "Suggests") +``` + +Furthermore, you will need to add a MapBox API key to be able to get DEM +datasets, by signing up and registering for a key at + and then following these +steps: + +``` r +usethis::edit_r_environ() +# Type in (register on the mapbox website): +MAPBOX_API_KEY=xxxxx +``` + ## Usage Load the package in the usual way: @@ -149,4 +169,4 @@ lisbon_route_3d_auto = slope_3d(lisbon_route) plot_slope(lisbon_route_3d_auto) ``` - + diff --git a/man/figures/README-dem-lisbon-1.png b/man/figures/README-dem-lisbon-1.png index d0d9be1..5e343bc 100644 Binary files a/man/figures/README-dem-lisbon-1.png and b/man/figures/README-dem-lisbon-1.png differ diff --git a/man/figures/README-plot_slope-1.png b/man/figures/README-plot_slope-1.png index 2bd7381..d4aca5d 100644 Binary files a/man/figures/README-plot_slope-1.png and b/man/figures/README-plot_slope-1.png differ diff --git a/man/figures/README-route-1.png b/man/figures/README-route-1.png index 0e06c9a..316f210 100644 Binary files a/man/figures/README-route-1.png and b/man/figures/README-route-1.png differ diff --git a/man/figures/README-slope-vis-1.png b/man/figures/README-slope-vis-1.png index e3c041c..ac4f788 100644 Binary files a/man/figures/README-slope-vis-1.png and b/man/figures/README-slope-vis-1.png differ