opensensemap/opensensmapR
1
0
Fork 0
mirror of https://github.com/sensebox/opensensmapr synced 2025-02-23 16:23:58 +01:00
Code Issues Releases Wiki Activity

minor reformatting of README

Browse source
This commit is contained in:
nuest 2018-01-14 22:29:56 +01:00
parent b852f6aac3
commit 3f7ef00caa
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -2,8 +2,7 @@
[![CRAN status](http://www.r-pkg.org/badges/version/opensensmapr)](https://cran.r-project.org/package=opensensmapr) [![Travis build status](https://travis-ci.org/noerw/opensensmapR.svg?branch=master)](https://travis-ci.org/noerw/opensensmapR) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/noerw/opensensmapR?branch=master&svg=true)](https://ci.appveyor.com/project/noerw/opensensmapR) [![Coverage status](https://codecov.io/gh/noerw/opensensmapR/branch/master/graph/badge.svg)](https://codecov.io/github/noerw/opensensmapR?branch=master) [![CRAN status](http://www.r-pkg.org/badges/version/opensensmapr)](https://cran.r-project.org/package=opensensmapr) [![Travis build status](https://travis-ci.org/noerw/opensensmapR.svg?branch=master)](https://travis-ci.org/noerw/opensensmapR) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/noerw/opensensmapR?branch=master&svg=true)](https://ci.appveyor.com/project/noerw/opensensmapR) [![Coverage status](https://codecov.io/gh/noerw/opensensmapR/branch/master/graph/badge.svg)](https://codecov.io/github/noerw/opensensmapR?branch=master)
This R package ingests data (environmental measurements, sensor stations) from This R package ingests data (environmental measurements, sensor stations) from the API of opensensemap.org for analysis in R.
the API of opensensemap.org for analysis in R.
The package aims to be compatible with sf and the tidyverse. The package aims to be compatible with sf and the tidyverse.
## Installation ## Installation
@ -18,8 +17,8 @@ devtools::install_github('noerw/opensensmapr')
## Usage ## Usage
A verbose usage example is shown in the vignette [`osem-intro`](https://noerw.github.com/opensensmapR/inst/doc/osem-intro.html). A verbose usage example is shown in the vignette [`osem-intro`](https://noerw.github.com/opensensmapR/inst/doc/osem-intro.html).
Each functions documentation can be viewed with `?<function-name>`. An overview Each functions documentation can be viewed with `?<function-name>`.
is given in `?opensensmapr`. An overview is given in `?opensensmapr`.
In short, the following pseudocode shows the main functions for data retrieval: In short, the following pseudocode shows the main functions for data retrieval:
```r ```r
@ -49,8 +48,8 @@ This project adheres to semantic versioning, for changes in recent versions plea
## FAQ ## FAQ
- *Whats up with that package name?* idk, the R people seem to [enjoy][1] - *Whats up with that package name?* idk, the R people seem to [enjoy][1] [dropping][2] [vovels][3] so..
[dropping][2] [vovels][3] so.. Unfortunately I couldn't fit the naming convention to drop an `y` in there. Unfortunately I couldn't fit the naming convention to drop an `y` in there.
[1]: https://github.com/tidyverse/readr [1]: https://github.com/tidyverse/readr
[2]: https://github.com/tidyverse/dplyr [2]: https://github.com/tidyverse/dplyr