documentation, news, and update version number

Author: jhmigueles

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: actimetric
 Type: Package
 Title: Classifies Accelerometer Data Into Physical Activity Types
-Version: 0.1.3
+Version: 0.1.4
 Authors@R: c(person("Jairo H","Migueles", role = c("aut","cre"),
                     email = "[email protected]",
                     comment = c(ORCID = "0000-0003-0366-6935")),

NEWS.md

@@ -1,3 +1,8 @@
+# actimetric 0.1.4
+
+* Time series: stores classes as factor in time series to ease interpretation #51
+* Documentation: minor revision of documentation for functions check_classifier and getBout #41
+
 # actimetric 0.1.3
 
 * Calibration: fix minor bug by which calibration procedure was using time column instead of acceleration columns in data #49

R/check_classifier.R

@@ -9,8 +9,6 @@
 #'
 #' @return Character with the definitive classifier
 #' @export
-#'
-#' @examples
 #' @author Jairo H. Migueles <[email protected]>
 #' check_classifier("Adult wrist Trost")
 check_classifier = function(classifier) {

R/getBout.R

@@ -10,7 +10,7 @@
 #' @param epoch Integer (default = 5) indicating the epoch length in seconds.
 #' @param boutmaxgap Integer (default = 1) with maximum consecutive gap length allowed in bout calculation.
 #'
-#' @return
+#' @return Vector with 0's and 1's indicating bout occurrences.
 #' @export
 #' @references GGIR R Package. doi: 10.1123/jmpb.2018-0063
 getBout = function(x, boutduration = 10, boutcriter = 0.8, boutmaxgap = 1, epoch = 5) {