Skip to content

Commit

Permalink
add gitlab,bb,sr.ht to remotes options
Browse files Browse the repository at this point in the history
  • Loading branch information
mpadge committed Mar 4, 2020
1 parent d0f30d3 commit 7233883
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 23 deletions.
14 changes: 9 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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")
```

Expand Down
39 changes: 21 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- README.md is generated from README.Rmd. Please edit that file -->
osmdata <a href='https://docs.ropensci.org/osmdata/'><img src='man/figures/osmhex.png' align="right" height=210 width=182/></a>
===============================================================================================================================

# osmdata <a href='https://docs.ropensci.org/osmdata/'><img src='man/figures/osmhex.png' align="right" height=210 width=182/></a>

[![Build
Status](https://travis-ci.org/ropensci/osmdata.svg?branch=master)](https://travis-ci.org/ropensci/osmdata)
Expand All @@ -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)

<!--![](./man/figures/title.png)-->

[![](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)

Expand All @@ -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")
```

Expand All @@ -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
Expand Down Expand Up @@ -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")
Expand All @@ -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
Expand Down

0 comments on commit 7233883

Please sign in to comment.