update documentation

wadpac · Oct 30, 2023 · 38e49fa · 38e49fa
1 parent 89efeee
commit 38e49fa
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/man/g.imputeTimegaps.Rd b/man/g.imputeTimegaps.Rd
@@ -43,8 +43,11 @@
   }
 }
 \value{
-  Data.frame based on input x with timegaps imputed (as default) or with
+  List including:
+  - P, data.frame based on input x with timegaps imputed (as default) or with 
   recordings with 0 values in the three axes removed (if impute = FALSE)
+  - QClog, data.frame with information on the number of time gaps found and the 
+  total time imputed in minutes
 }
 \author{
   Vincent T van Hees <v.vanhees@accelting.com>

diff --git a/vignettes/GGIR.Rmd b/vignettes/GGIR.Rmd
@@ -788,14 +788,14 @@ The data_quality_report.csv is stored in subfolder folder results/QC.
 | mean.temp	|  Mean temperature in sphere data |
 | device.serial.number	| Device serial number |
 | NFilePagesSkipped	| (Only for Axivity .cwa format) Number of data blocks skipped |
-| filehealth_totimp_min | (Only for Axivity .cwa format) Total number of minutes of data imputed |
+| filehealth_totimp_min | Total number of minutes of data imputed |
 | filehealth_checksumfail_min	| (Only for Axivity .cwa format) Total number of minutes of data where the checksum failed |
 | filehealth_niblockid_min |  (Only for Axivity .cwa format) Total number of minutes of data with non-incremental block ids |
 | filehealth_fbias0510_min | (Only for Axivity .cwa format) Total number of minutes with a sampling frequency bias between 5 and 10% |
 | filehealth_fbias1020_min | (Only for Axivity .cwa format) Total number of minutes with a sampling frequency bias between 10 and 20% |
 | filehealth_fbias2030_min |  (Only for Axivity .cwa format) Total number of minutes with a sampling frequency bias between 20 and 30% |
 | filehealth_fbias30_min | (Only for Axivity .cwa format) Total number of minutes with a sampling frequency bias higher than 30% |
-| filehealth_totimp_N | (Only for Axivity .cwa format) Total number of data blocks that were imputed |
+| filehealth_totimp_N | Total number of data blocks that were imputed |
 | filehealth_checksumfail_N	| (Only for Axivity .cwa format)  Total number of blocks where the checksum failed  |
 | filehealth_niblockid_N | (Only for Axivity .cwa format) Total number of data blocks with non-incremental block ids  |
 | filehealth_fbias0510_N | (Only for Axivity .cwa format) Total number of data blocks with a sampling frequency bias between 5 and 10% |