clarify unit of timestamps in read.myacc.csv output

man/read.myacc.csv.Rd

@@ -180,8 +180,9 @@
   except rmc.file, rmc.nrow, and  rmc.skip as input for function \link{GGIR} or \link{g.part1} and also specify argument rmc.noise, which is not part of this function but needed to tell GGIR what noise level to expect in the data. The rmc.noise is taken from the params_rawdata object if not explicitly specified by user.
 }
 \value{
-  List with objects data holding the time series of acceleration, and
-  header if it was available in the orignal file.
+  List with objects data holding the time series of acceleration with among others
+  a column named "time" that holds the time expressed in seconds since 1-1-1970, and
+  header if a header was present in the input file.
 }
 \examples{
 

vignettes/readmyacccsv.Rmd

@@ -116,7 +116,7 @@ Before we can use this with GGIR, we first test read this file using the `read.m
 
 ```{R,eval=FALSE}
 library(GGIR)
-read.myacc.csv(rmc.file = "C:/mystudy/mydata/datafile.csv",
+data = read.myacc.csv(rmc.file = "C:/mystudy/mydata/datafile.csv",
                rmc.nrow = Inf,
                rmc.skip = 0,
                rmc.dec = ".",
@@ -132,6 +132,9 @@ read.myacc.csv(rmc.file = "C:/mystudy/mydata/datafile.csv",
                rmc.sf = 100)
 ```
 
+The object data is a list with a data.frame name data and a header.
+The time column in the data.frame represents timestamps expressed in seconds since 1-1-1970.
+
 ## Example using the shell function
 
 If the `rmc.firstrow.acc` argument is defined within the `GGIR` function, then the data will be read through `read.myacc.csv`. GGIR needs the user to specify in which row starts the accelerometer data within the csv, so this argument must be always explicitly specified by the user. Thus, a call to the `GGIR` including the rmc arguments would look as follows (note that the `rmc.file`, `rmc.nrow`, and `rmc.skip` arguments will not be used by `GGIR` as these arguments are already defined by `datadir`, `strategy`, and [header](#header) arguments, respectively).