fix review comments

1. Write a new vignette that uses internal data-sets 2. make error messages more user friendly 3. add CONTRIBUTING.md 4. edit and move paper.md to root 5. use @title, @description, @details and @section tags 6. almost all get* functions use @Rdname get_tables 7. rewrite tests using skip_on_cran() and a custom skip_if_not_online() function 8. run goodpractice::gp() with clear output
ropensci · Feb 11, 2018 · 0026e79 · 0026e79
1 parent 83453ee
commit 0026e79
Show file tree

Hide file tree

Showing 69 changed files with 1,314 additions and 1,140 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -5,8 +5,11 @@
 ^\.travis\.yml$
 ^appveyor\.yml$
 ^cran-comments\.md$
-^inst/paper$
+paper.bib
+paper.md
 ^CONDUCT.md$
+^CONTRIBUTING.md$
 ^\.bib$
-^data_create$
 ^docs$
+^data-raw$
+^LICENSE\.md$
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Suggestions and bug reports
+
+`hydroscoper` thrives on the suggestions and bug reports you submit to the [issue tracker](https://github.com/kvantas/hydroscoper/issues). Before posting, please search both the open and closed issues to help us avoid duplication.
+
+# Patches to code and documentation
+
+Please help us develop `hydroscoper`. It really helps us manage the exciting but accelerating stream of incoming [issues](https://github.com/kvantas/hydroscoper/issues). To submit a patch, please [fork this repository](https://help.github.com/articles/fork-a-repo/) and submit a [pull request](https://github.com/kvantas/hydroscoper/pulls).
+
+# Best ways to help
+
+Multiple [issues](https://github.com/ropensci/kvantas/hydroscoper) are labeled ["help wanted"](https://github.com/kvantas/hydroscoper/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). We would particularly appreciate your input there.
+
+# Contributing
+
+Maintainers and other contributors must follow this repository's [code of conduct](https://github.com/kvantas/hydroscoper/blob/master/CONDUCT.md).
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,14 +1,14 @@
 Package: hydroscoper
 Type: Package
 Title: Interface to Hydroscope
-Version: 0.2.2
+Version: 0.2.3
 Authors@R: person("Konstantinos", "Vantas", role = c("aut", "cre"),
   email = "[email protected]",
   comment = c(ORCID = "0000-0001-6387-8791"))
 Maintainer: Konstantinos Vantas <[email protected]>
 Description: R interface to the  Greek National Data Bank for Hydrological and 
-    Meteorological Information <http://www.hydroscope.gr/>. It 
-    covers Hydroscope's data sources and provides functions to transliterate, 
+    Meteorological Information <http://www.hydroscope.gr/>. It covers 
+    Hydroscope's data sources and provides functions to transliterate, 
     translate and download them into tidy dataframes (tibbles).
 URL: https://github.com/kvantas/hydroscoper
 BugReports: https://github.com/kvantas/hydroscoper/issues             
@@ -23,10 +23,10 @@ Imports: stringi (>= 1.1.6),
     pingr (>= 1.1.2),
     readr (>= 1.1.1),
     jsonlite (>= 1.5),
-Suggests: plyr (>= 1.8.4),
+    plyr (>= 1.8.4)
+Suggests: 
     ggplot2 (>= 2.2.1),
-    knitr (>= 1.17),
-    rmarkdown (>= 1.8),
-    testthat (>= 1.0.2),
-    ggmap (>= 2.6.1)
+    knitr,
+    rmarkdown,
+    testthat (>= 1.0.2)
 VignetteBuilder: knitr
diff --git a/LICENSE b/LICENSE
@@ -1,2 +1,2 @@
-YEAR: 2017
+YEAR: 2018
 COPYRIGHT HOLDER: Konstantinos Vantas
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2018 Konstantinos Vantas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/NEWS.md b/NEWS.md
@@ -1,25 +1,14 @@
-# hydroscoper 0.2.2 (Release date: 2018-01-12)
+# hydroscoper 0.2.3 (Release date: 2018-02-11)
 
-* General 
-
-  - This is a minor update. Added conditionaly evaluation in vignette "Getting Hydroscope's data".
-  - Use ping function to check if a sub-domain is alive.
-
-# hydroscoper 0.2.1 (Release date: 2018-01-10)
-
-* General 
-
-  - This is a minor update. All the functions return now a tibble.
-
-
-# hydroscoper 0.2.0 (Release date: 2018-01-09)
-
-* General 
+* General
 
   - This is a major update. All the functions were rewritten utilizing the Enhydris API.
   - The included data in the package cover all Hydroscope's databases.
-  - Added vignettes  "Getting Hydroscope's data" and "Hydroscope's stations with available data". Removed the vignette "Using hydroscoper to get stations' and time-series' data".
+  - Added vignettes  "Hydroscoper's data-sets".
   - Added package documentation page.
+  - Use pingr package to check if a sub-domain is alive.
+  - All the functions return a tibble.
+  - Added `greece_borders` dataset.
 
 * New functionality:
 
@@ -39,7 +28,8 @@
 
 * Changes
 
-  - `get_stations` and `get_timeseries` use the Enhydris API and are considerably faster, because the older versions used web scrapping.
+  - `get_stations` and `get_timeseries` use the Enhydris API and are considerably faster.
+  - `get_data` uses lower case variable naming: `dates, values, comments`
 
 * Defuncs
 

diff --git a/R/data.R b/R/data.R
@@ -1,7 +1,7 @@
-#' stations
+#' @title stations
 #'
-#' Stations' data from the Greek National Data Bank for Hydrological and
-#' Meteorological Information.
+#' @description  Stations' data from the Greek National Data Bank for
+#' Hydrological and Meteorological Information.
 #'
 #' @format A data frame:
 #' \describe{
@@ -17,10 +17,10 @@
 #' }
 "stations"
 
-#' timeseries
+#' @title timeseries
 #'
-#' Time series' data from the Greek National Data Bank for Hydrological and
-#' Meteorological Information, Ministry of Environment and Energy.
+#' @description Time series' data from the Greek National Data Bank for
+#' Hydrological and Meteorological Information.
 #'
 #' @format A data frame:
 #' \describe{
@@ -34,3 +34,21 @@
 #'     \item{subdomain}{The corresponding Hydroscope's database}
 #' }
 "timeseries"
+
+#' @title Greek borders
+#'
+#' @description The borders of Greece are taken from Geoadata.gov.gr.  The
+#' variables are created using the function tidy from the broom package. This
+#' data frame was created for use with the geom_polygon from ggplot2 package.
+#'
+#' @format A data frame with 18474 rows and 8 variables:
+#' \describe{
+#'   \item{long}{Longitude in decimal degrees, ETRS89}
+#'   \item{lat}{Latitude in decimal degrees, ETRS89}
+#'   \item{order}{order, integer}
+#'   \item{hole}{hole, boolean}
+#'   \item{piece}{piece, integer}
+#'   \item{group}{group, numeric}
+#' }
+#' @source \url{http://geodata.gov.gr/}
+"greece_borders"
diff --git a/R/defunct.R b/R/defunct.R
@@ -1,9 +1,11 @@
-#' Defunct functions in hydroscoper
+#' @title  Defunct functions in hydroscoper
 #'
-#' These functions are no longer available in \pkg{hydroscoper}.
+#' @description  These functions are no longer available in \pkg{hydroscoper}.
 #'
 #' @param ... Defunct function's parameters
 #'
+#' @details  Defunct functions:
+#'
 #' \itemize{
 #'  \item \code{\link{get_coords}}: This function is defunct. Please use
 #'  \code{\link{hydro_coords}} to convert Hydroscope's points raw format to a

diff --git a/R/enhydris.R b/R/enhydris.R