Merge pull request #44 from PhysicalActivityOpenTools/issue41_documentation

Documentation

Author: jhmigueles

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: actimetric
 Type: Package
 Title: Classifies Accelerometer Data Into Physical Activity Types
-Version: 0.1.1
+Version: 0.1.2
 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,7 @@
+# actimetric 0.1.2
+
+* Documentation: include references to papers, other pieces of code, packages, and authorships #41
+
 # actimetric 0.1.1
 
 * Data reading: fix minor bug when reading short files #25

R/featuresTrost2017.R

@@ -15,6 +15,7 @@
 #' accelerometer data. J Sci Med Sport. 2017 Jan;20(1):75-80.
 #' doi: 10.1016/j.jsams.2016.06.003
 #' @author Matthew N. Ahmadi <[email protected]>
+#' @author Stewart G. Trost <[email protected]>
 featuresTrost2017 = function(data, epoch, sf) {
   # original code provided by Matthew N. Ahmadi
   window = epoch * sf

R/featuresTrost2018.R

@@ -28,6 +28,7 @@
 #' @import stats
 #' @importFrom e1071 skewness kurtosis
 #' @author Matthew N. Ahmadi <[email protected]>
+#' @author Stewart G. Trost <[email protected]>
 featuresTrost2018 = function(data, vm, epoch, overlap, sf,
                              lowerBound = 0.25, upperBound = 5) {
   # INTERNAL FUNCTIONS (only used here) -------------------------------------