minor edits in preparation for new GitHub release

wadpac · Aug 3, 2023 · a7293d8 · a7293d8
1 parent 52857dd
commit a7293d8
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 9 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: GGIRread
 Type: Package
 Title: Wearable Accelerometer Data File Readers
 Version: 0.2.10
-Date: 2023-08-10
+Date: 2023-08-03
 Authors@R: c(person("Vincent T","van Hees",role=c("aut","cre"),
                   email="[email protected]"),
              person(given = "Patrick",family = "Bos",

diff --git a/R/readAxivity.R b/R/readAxivity.R
@@ -554,11 +554,12 @@ readAxivity = function(filename, start = 0, end = 0, progressBar = FALSE, desire
       }
     }
     if (doQClog == TRUE) {
+      # Note: This is always a description of the previous block
       QClog = rbind(QClog, data.frame(checksum_pass = prevRaw$checksum_pass,
-                                      blockID_previous = prevRaw$blockID,
-                                      blockID_current = raw$blockID,
-                                      start_previous = prevRaw$start,
-                                      start_current = raw$start,
+                                      blockID_current = prevRaw$blockID,
+                                      blockID_next = raw$blockID,
+                                      start = prevRaw$start,
+                                      end = raw$start,
                                       blockLengthSeconds = raw$start - prevRaw$start,
                                       frequency_blockheader = prevRaw$frequency,
                                       frequency_observed = frequency_observed,

diff --git a/inst/NEWS.Rd b/inst/NEWS.Rd
@@ -1,16 +1,15 @@
 \name{NEWS}
 \title{News for Package \pkg{GGIRread}}
 \newcommand{\cpkg}{\href{http://CRAN.R-project.org/package=#1}{\pkg{#1}}}
-\section{Changes in version 0.2.10 (release date: 10-08-2023)}{
+\section{Changes in version 0.2.10 (release date: 03-08-2023)}{
     \itemize{
       \item Fixed bug in temperature extraction Axivity cwa files (credits: Lena Kushleyeva)
       \item readAxivity now able to recognise when AX6 has been configured without 
       gyroscope sensor and only provides accerometer data. Fixes #31 (credits: Lena Kushleyeva)
       \item readAxivity refactored and faster (credits: Lena Kushleyeva)
       but also expanded with checksum check and sampling frequency check, 
       data blocks are imputed when checks fail and this is logged in the output. 
-      These extra steps have slowed down readAxivity. The net speed increase is 
-      approximately 5\%.
+      The net speed improvement is approximately 15\%-20\%.
     }
 }
 \section{Changes in version 0.2.9 (GitHub-only-release date:20-07-2023)}{

diff --git a/man/GGIRread-package.Rd b/man/GGIRread-package.Rd
@@ -15,7 +15,7 @@
   Package: \tab GGIRread\cr
   Type: \tab Package\cr
   Version: \tab 0.2.10\cr
-  Date: \tab 2023-08-10\cr
+  Date: \tab 2023-08-03\cr
   License: \tab LGPL (>= 2.0, < 3)\cr
   }
 }

diff --git a/man/readAxivity.Rd b/man/readAxivity.Rd
@@ -54,6 +54,9 @@
     that we accept the sampling frequency configured at 100 Hertz to vary between
     90 and 110 Hertz. If this condition is not met the data will be imputed with
     a constant value and the start and end time will be logged in the QClog output object.
+    Regardless of the setting the function will always log instances when frequency 
+    differs by more than 5\%, but if this is less than frequency_tol the block will
+    not be imputed.
   }
 
 }