Skip to content

Commit

Permalink
updated README.Rmd
Browse files Browse the repository at this point in the history
  • Loading branch information
dleutnant committed Oct 16, 2017
1 parent 3228b53 commit 2628068
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 265 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Package: influxdbr
Type: Package
Title: R Interface to InfluxDB
Version: 0.13.0.9000
Date: 2017-10-10
Date: 2017-10-16
Authors@R: person("Dominik", "Leutnant", email = "[email protected]", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-3293-2315"))
Description: An R interface to the InfluxDB time series database <https://www.influxdata.com>. This package allows you to fetch and write time series data from/to an InfluxDB server. Additionally, handy wrappers for the Influx Query Language (IQL) to manage and explore a remote database are provided.
License: GPL-3
Expand Down
7 changes: 2 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ to be of class `tibble` or of class `xts`.

#### Return tibbles

ToDo: List of tibbles, each with statement_id, series_names, tags, time, fields
If `return_xts = FALSE` a list of tibbles per query statement is returned. Each tibble contains columns with statement_id, series_names, tags, time and fields.

```{r return_tibble}
# fetch time series data by using the helper function `influx_select`
Expand All @@ -135,10 +135,7 @@ result

#### Return xts

ToDo: List of xts. Because xts objects are basically matrices (which can store one data type only),
a single xts object is created for each InfluxDB field. This ensures a correct
representation of the field values data type (instead of getting all into a "character" matrix).
InfluxDB tags are now xts attributes.
If `return_xts = TRUE` a list of xts objects per query statement is returned. Because xts objects are basically matrices (which can store one data type only), a single xts object is created for each InfluxDB field. This ensures a correct representation of the field values data type (instead of getting all into a "character" matrix). InfluxDB tags are now xts attributes.

```{r return_xts}
# fetch time series data by using the helper function `influx_select`
Expand Down
259 changes: 0 additions & 259 deletions README.md

This file was deleted.

0 comments on commit 2628068

Please sign in to comment.