Merge pull request #9 from andrie/dev

Merge dev to master for release candidate 0.2.2

.Rbuildignore

@@ -5,7 +5,11 @@
 ^cran-comments\.md$
 .travis.yml
 dev
+
 ^codecov\.yml$
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+
+^logo.svg$
+^rrdtool.svg$

.gitignore

@@ -7,3 +7,4 @@ src/*.so
 src/*.dll
 
 docs
+src/Makevars

.travis.yml

@@ -35,3 +35,10 @@ matrix:
     - name: "Devel"
       r: devel
 
+    - name: "OSX"
+      r: release
+      os: osx
+      before_install: 
+      - brew update
+      - brew install rrdtool
+

DESCRIPTION

@@ -1,16 +1,19 @@
 Package: rrd
 Type: Package
 Title: Import Data from a RRD (Round Robin Database) File
-Version: 0.2.1.9001
-Date: 2019-07-04
+Version: 0.2.2
+Date: 2019-07-05
 Authors@R: c(
     person("Andrie", "de Vries", email = "apdevries@gmail.com", role = c("cre", "cph")), 
-    person("Plamen", "Dimitrov", email = "dim.plamen@gmail.com", role = c("aut", "cph"))
+    person("Plamen", "Dimitrov", email = "dim.plamen@gmail.com", role = c("aut", "cph")),
+    person("Tobias", "Oettiker", role = "cph", comment = "rrdtool and rrd library, https://oss.oetiker.ch/rrdtool/")
     )
 Description: Makes it easy to import the data from a 'RRD' database 
    (<https://oss.oetiker.ch/rrdtool/>) directly into R data structures. The 
    resulting objects are 'tibble' objects or a list of 'tibble' objects, making
-   it easy to manipulate the data.
+   it easy to manipulate the data.  The package uses `librrd` to import the 
+   numerical data in a `RRD` database directly into R data structures without 
+   using intermediate formats.
 URL: https://github.com/andrie/rrd/, https://andrie.github.io/rrd/
 BugReports: https://github.com/andrie/rrd/issues
 SystemRequirements: The package depends on libraries from the RRD project

NEWS

@@ -1,3 +1,12 @@
+rrd-0.2.2 (2019-07-05)
+=========
+
+
+* Bug fix on larger RRD files that cause corruption and segfaults, provided by Steven Rezsutek (#8)
+* Provided configuration that tests for installation on various platforms (using `anticonf` by Jeroen Ooms)
+* Added documentation for installation instructions on OSX (#7)
+
+
 rrd-0.2.0 (2018-06-20)
 =========
 

R/rrd-package.R

@@ -1,8 +1,3 @@
-#' Import Data from a RRD (Round Robin Database) File
-#' 
-#' The package uses `librrd` to import the numerical data in a `RRD` database
-#' directly into R data structures without using intermediate formats.
-#' 
 #' @section Details:
 #' 
 #' Exposes the following functions:
@@ -36,7 +31,7 @@
 #' 
 #' @importFrom assertthat assert_that
 #' 
-NULL
+"_PACKAGE"
 
 
 

README.Rmd

@@ -28,17 +28,23 @@ The `rrd` package allows you to read data from an [RRD](http://oss.oetiker.ch/rr
 
 ## Installation
 
+### System requirements
+
 In order to build the package from source you need [librrd](http://oss.oetiker.ch/rrdtool/doc/librrd.en.html).
 Installing [RRDtool](http://oss.oetiker.ch/rrdtool/) from your package manager will usually also install the library.
 
-Platform      | Installation 
-------------- | -----------------------------------------
-Ubuntu        | `apt-get install librrd-dev`
-RHEL / CentOS | `yum install rrdtool-devel`
-Fedora        | `dnf install rrdtool-devel`
-Windows       | Not available
-OSX           | ???
+Platform        | Installation                   | Reference
+-------------   | ------------------------------ | -----------------------------
+Debian / Ubuntu | `apt-get install librrd-dev`   |
+RHEL / CentOS   | `yum install rrdtool-devel`    |
+Fedora          | `dnf install rrdtool-devel`    | https://apps.fedoraproject.org/packages/rrdtool-devel
+Solaris / CSW   | Install `rrdtool`              | https://www.opencsw.org/packages/rrdtool/
+OSX             | `brew install rrdtool`         |
+Windows         | Not available                  |
+
+Note: on OSX you may have to update `xcode`, using `xcode-select --install`.
 
+### Package installation
 
 You can install the stable version of the package from CRAN:
 
@@ -49,8 +55,8 @@ install.packages("rrd")
 And the development version from [GitHub](https://github.com/):
 
 ``` r
-# install.packages("devtools")
-devtools::install_github("andrie/rrd")
+# install.packages("remotes")
+remotes::install_github("andrie/rrd")
 ```
 
 ## About RRD and RRDtool <img src='man/figures/rrdtool-logo.png' align="right" height="70" />
@@ -63,18 +69,19 @@ For an introduction to RRD database, see https://oss.oetiker.ch/rrdtool/tut/rrd-
 ## Example
 
 
-In R:
+The package contains some example RRD files that originated in an instance of RStudio Connect.  In this example, you analyse CPU data in the file `cpu-0.rrd`.
+
+Load the package and assign the location of the `cpu-0.rrd` file to a variable:
 
 ```{r load}
 library(rrd)
+rrd_cpu_0 <- system.file("extdata/cpu-0.rrd", package = "rrd")
 ```
 
 To describe the contents of an RRD file, use `describe_rrd()`:
 
 
 ```{r describe}
-rrd_cpu_0 <- system.file("extdata/cpu-0.rrd", package = "rrd")
-
 describe_rrd(rrd_cpu_0)
 ```
 

README.md

@@ -19,18 +19,27 @@ The `rrd` package allows you to read data from an
 
 ## Installation
 
+### System requirements
+
 In order to build the package from source you need
 [librrd](http://oss.oetiker.ch/rrdtool/doc/librrd.en.html). Installing
 [RRDtool](http://oss.oetiker.ch/rrdtool/) from your package manager will
-usually also install the library.
+usually also install the
+library.
+
+| Platform        | Installation                 | Reference                                               |
+| --------------- | ---------------------------- | ------------------------------------------------------- |
+| Debian / Ubuntu | `apt-get install librrd-dev` |                                                         |
+| RHEL / CentOS   | `yum install rrdtool-devel`  |                                                         |
+| Fedora          | `dnf install rrdtool-devel`  | <https://apps.fedoraproject.org/packages/rrdtool-devel> |
+| Solaris / CSW   | Install `rrdtool`            | <https://www.opencsw.org/packages/rrdtool/>             |
+| OSX             | `brew install rrdtool`       |                                                         |
+| Windows         | Not available                |                                                         |
 
-| Platform      | Installation                 |
-| ------------- | ---------------------------- |
-| Ubuntu        | `apt-get install librrd-dev` |
-| RHEL / CentOS | `yum install rrdtool-devel`  |
-| Fedora        | `dnf install rrdtool-devel`  |
-| Windows       | Not available                |
-| OSX           | ???                          |
+Note: on OSX you may have to update `xcode`, using `xcode-select
+--install`.
+
+### Package installation
 
 You can install the stable version of the package from CRAN:
 
@@ -41,8 +50,8 @@ install.packages("rrd")
 And the development version from [GitHub](https://github.com/):
 
 ``` r
-# install.packages("devtools")
-devtools::install_github("andrie/rrd")
+# install.packages("remotes")
+remotes::install_github("andrie/rrd")
 ```
 
 ## About RRD and RRDtool <img src='man/figures/rrdtool-logo.png' align="right" height="70" />
@@ -57,17 +66,21 @@ For an introduction to RRD database, see
 
 ## Example
 
-In R:
+The package contains some example RRD files that originated in an
+instance of RStudio Connect. In this example, you analyse CPU data in
+the file `cpu-0.rrd`.
+
+Load the package and assign the location of the `cpu-0.rrd` file to a
+variable:
 
 ``` r
 library(rrd)
+rrd_cpu_0 <- system.file("extdata/cpu-0.rrd", package = "rrd")
 ```
 
 To describe the contents of an RRD file, use `describe_rrd()`:
 
 ``` r
-rrd_cpu_0 <- system.file("extdata/cpu-0.rrd", package = "rrd")
-
 describe_rrd(rrd_cpu_0)
 #> A RRD file with 10 RRA arrays and step size 60
 #> [1] AVERAGE_60 (43200 rows)