Fix documentation and add note about data range representation cludge
Change-Id: I1d4e9926e167963caedc547205a2c0cecf604ae8
diff --git a/R/visitssummary.R b/R/visitssummary.R
index 648c01b..3b99349 100644
--- a/R/visitssummary.R
+++ b/R/visitssummary.R
@@ -9,12 +9,12 @@
#' @param period \code{day}, \code{week}, \code{month} or \code{year}
#' @param date date range (see \url{https://developer.matomo.org/api-reference/reporting-api})
#' @param filter_limit defines the maximum number of rows to be returned
-#' @param accessToken API Authentication Token - you can get this in your
-#' matomo interface under Settings -> Personal -> Settings -> API Authentication Token
#' @param removeFirst logical that determines whether the first row of each site should be removed (to account for incomplete periods)
#' @param removeLast logical that determines whether the last row of each site should be removed (to account for incomplete periods)
+#' @param accessToken API Authentication Token - you can get this in your
+#' matomo interface under Settings -> Personal -> Settings -> API Authentication Token
#' and pass it here, or you can make it persistent with \code{\link{persistAccessToken}}.
-#' @return data frame
+#' @return Data frame with visits summary as returned by matomo. Note that the \code{date} column in the returned data frame refers to the first day of the respective period.
#'
#' @import httr
#' @importFrom jsonlite fromJSON
diff --git a/Readme.md b/Readme.md
index ba06caf..e2a1bdb 100644
--- a/Readme.md
+++ b/Readme.md
@@ -14,6 +14,8 @@
See matomo [Reporting API Reference](https://developer.matomo.org/api-reference/reporting-api) for details.
+NOTE: Currently, the `date` column in the data frame results refers to the first day of the respective period.
+
### Usage
```R
getVisitsSummary(
@@ -37,8 +39,8 @@
date | date range (see [matomo API reference](https://developer.matomo.org/api-reference/reporting-api))
filter_limit | defines the maximum number of rows to be returned
removeFirst |logical that determines whether the first row of each site should be removed (to account for incomplete periods)
-removeLast | logical that determines whether the last row of each site should be removed (to account for incomplete periods) and pass it here, or you can make it persistent with persistAccessToken.|
-accessToken | API Authentication Token - you can get this in your matomo interface under Settings -> Personal -> Settings -> API Authentication Token
+removeLast | logical that determines whether the last row of each site should be removed (to account for incomplete periods)
+accessToken | API Authentication Token - you can get this in your matomo interface under Settings -> Personal -> Settings -> API Authentication Token and pass it here, or you can make it persistent with persistAccessToken.
## Examples
diff --git a/man/getVisitsSummary.Rd b/man/getVisitsSummary.Rd
index 096897b..7ce6eea 100644
--- a/man/getVisitsSummary.Rd
+++ b/man/getVisitsSummary.Rd
@@ -28,14 +28,14 @@
\item{removeFirst}{logical that determines whether the first row of each site should be removed (to account for incomplete periods)}
-\item{removeLast}{logical that determines whether the last row of each site should be removed (to account for incomplete periods)
-and pass it here, or you can make it persistent with \code{\link{persistAccessToken}}.}
+\item{removeLast}{logical that determines whether the last row of each site should be removed (to account for incomplete periods)}
\item{accessToken}{API Authentication Token - you can get this in your
-matomo interface under Settings -> Personal -> Settings -> API Authentication Token}
+matomo interface under Settings -> Personal -> Settings -> API Authentication Token
+and pass it here, or you can make it persistent with \code{\link{persistAccessToken}}.}
}
\value{
-data frame
+Data frame with visits summary as returned by matomo. Note that the \code{date} column in the returned data frame refers to the first day of the respective period.
}
\description{
See matomo Reporting API Reference (\url{https://developer.matomo.org/api-reference/reporting-api}) for details.