From 7233883eb78c1afe00556f95b88a9116e7b0833e Mon Sep 17 00:00:00 2001 From: mpadge Date: Wed, 4 Mar 2020 11:19:03 +0100 Subject: [PATCH] add gitlab,bb,sr.ht to remotes options --- README.Rmd | 14 +++++++++----- README.md | 39 +++++++++++++++++++++------------------ 2 files changed, 30 insertions(+), 23 deletions(-) diff --git a/README.Rmd b/README.Rmd index 9c3d831b..a93dfa2e 100644 --- a/README.Rmd +++ b/README.Rmd @@ -56,13 +56,17 @@ The package is designed to allow access to small-to-medium-sized OSM datasets (s ## Installation -To install: -```{r, eval=FALSE} -# Install from CRAN +To install latest CRAN version: +```{r cran-install, eval=FALSE} install.packages("osmdata") - -# Alternatively, install the development version +``` +Alternatively, install the development version with any one of the following +options: +```{r remotes, eval = FALSE} # install.packages("remotes") +remotes::install_git("https://git.sr.ht/~mpadge/osmdata") +remotes::install_bitbucket("mpadge/osmdata") +remotes::install_gitlab("mpadge/osmdata") remotes::install_github("ropensci/osmdata") ``` diff --git a/README.md b/README.md index ca36d77d..45817dc9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -osmdata -=============================================================================================================================== + +# osmdata [![Build Status](https://travis-ci.org/ropensci/osmdata.svg?branch=master)](https://travis-ci.org/ropensci/osmdata) @@ -14,6 +14,7 @@ Downloads](http://cranlogs.r-pkg.org/badges/grand-total/osmdata?color=orange)](h Active](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) + [![](https://badges.ropensci.org/103_status.svg)](https://github.com/ropensci/onboarding/issues/103) [![status](http://joss.theoj.org/papers/0f59fb7eaeb2004ea510d38c00051dd3/status.svg)](http://joss.theoj.org/papers/0f59fb7eaeb2004ea510d38c00051dd3) @@ -33,17 +34,22 @@ designed to allow access to small-to-medium-sized OSM datasets (see [`geofabrik`](https://github.com/ITSLeeds/geofabrik) for an approach for reading-in bulk OSM data extracts). -Installation ------------- +## Installation -To install: +To install latest CRAN version: ``` r -# Install from CRAN install.packages("osmdata") +``` -# Alternatively, install the development version +Alternatively, install the development version with any one of the +following options: + +``` r # install.packages("remotes") +remotes::install_git("https://git.sr.ht/~mpadge/osmdata") +remotes::install_bitbucket("mpadge/osmdata") +remotes::install_gitlab("mpadge/osmdata") remotes::install_github("ropensci/osmdata") ``` @@ -53,19 +59,18 @@ To load the package and check the version: library(osmdata) #> Data (c) OpenStreetMap contributors, ODbL 1.0. https://www.openstreetmap.org/copyright packageVersion("osmdata") -#> [1] '0.1.2' +#> [1] '0.1.3' ``` -Usage ------ +## Usage [Overpass API](https://wiki.openstreetmap.org/wiki/Overpass_API) queries can be built from a base query constructed with `opq` followed by `add_osm_feature`. The corresponding OSM objects are then downloaded and -converted to -[`R Simple Features (sf)`](https://cran.r-project.org/package=sf) -objects with `osmdata_sf()` or to -[`R Spatial (sp)`](https://cran.r-project.org/package=sp) objects with +converted to [`R Simple Features +(sf)`](https://cran.r-project.org/package=sf) objects with +`osmdata_sf()` or to [`R Spatial +(sp)`](https://cran.r-project.org/package=sp) objects with `osmdata_sp()`. For example, ``` r @@ -219,8 +224,7 @@ Data may also be trimmed to within a defined polygonal shape with the function. Full package functionality is described on the [website](https://docs.ropensci.org/osmdata/) -Citation --------- +## Citation ``` r citation ("osmdata") @@ -247,8 +251,7 @@ citation ("osmdata") #> } ``` -Code of Conduct ---------------- +## Code of Conduct Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree