From 3f7ef00caae1300ccc2cf0e4d033b782e4b4f053 Mon Sep 17 00:00:00 2001 From: nuest Date: Sun, 14 Jan 2018 22:29:56 +0100 Subject: [PATCH] minor reformatting of README --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8a56770..4b76fca 100644 --- a/README.md +++ b/README.md @@ -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) -This R package ingests data (environmental measurements, sensor stations) from -the API of opensensemap.org for analysis in R. +This R package ingests data (environmental measurements, sensor stations) from the API of opensensemap.org for analysis in R. The package aims to be compatible with sf and the tidyverse. ## Installation @@ -18,8 +17,8 @@ devtools::install_github('noerw/opensensmapr') ## Usage 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 `?`. An overview -is given in `?opensensmapr`. +Each functions documentation can be viewed with `?`. +An overview is given in `?opensensmapr`. In short, the following pseudocode shows the main functions for data retrieval: ```r @@ -49,8 +48,8 @@ This project adheres to semantic versioning, for changes in recent versions plea ## FAQ -- *Whats up with that package name?* idk, the R people seem to [enjoy][1] -[dropping][2] [vovels][3] so.. Unfortunately I couldn't fit the naming convention to drop an `y` in there. +- *Whats up with that package name?* idk, the R people seem to [enjoy][1] [dropping][2] [vovels][3] so.. +Unfortunately I couldn't fit the naming convention to drop an `y` in there. [1]: https://github.com/tidyverse/readr [2]: https://github.com/tidyverse/dplyr