added documentation _full and _cleaned output for part4, close issue w…

…adpac#233
m-patterson · Oct 5, 2019 · c29fd47 · c29fd47
1 parent 7d33b3c
commit c29fd47
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 7 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -41,7 +41,7 @@ authors:
     given-names: "Jairo H."
     orcid: "https://orcid.org/0000-0003-0366-6935"
 cff-version: "1.0.3"
-date-released: 2019-09-17
+date-released: 2019-10-05
 doi: "10.5281/zenodo.1051064"
 keywords:
   - "activity tracker"

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: GGIR
 Type: Package
 Title: Raw Accelerometer Data Analysis
 Version: 1.10-6
-Date: 2019-09-17
+Date: 2019-10-05
 Authors@R: c(person("Vincent T","van Hees",role=c("aut","cre"),
                   email="[email protected]"),
                   person("Zhou","Fang",role="ctb"),

diff --git a/inst/NEWS.Rd b/inst/NEWS.Rd
@@ -1,7 +1,7 @@
 \name{NEWS}
 \title{News for Package \pkg{GGIR}}
 \newcommand{\cpkg}{\href{http://CRAN.R-project.org/package=#1}{\pkg{#1}}}
-\section{Changes in version 1.10-6 (release date:22-09-2019)}{
+\section{Changes in version 1.10-6 (release date:05-10-2019)}{
 \itemize{
   \item Fixed functionality to supply calibration coefficients file to backup.cal.coef.
   \item Fix OSx flavor not being released on CRAN in previous version.

diff --git a/man/GGIR-package.Rd b/man/GGIR-package.Rd
@@ -91,7 +91,7 @@ journal/conference publications.
 Package: \tab GGIR\cr
 Type: \tab Package\cr
 Version: \tab 1.10-6\cr
-Date: \tab 2019-09-17\cr
+Date: \tab 2019-10-05\cr
 License: \tab LGPL (>= 2.0, < 3)\cr
 Discussion group: \tab https://groups.google.com/forum/#!forum/rpackageggir\cr
 }

diff --git a/man/g.report.part4.Rd b/man/g.report.part4.Rd
@@ -56,9 +56,21 @@ sleeplog.
 
 If you have a study where the sleeplog was available for a subset of the
 participants, but you want to include all individuals in your analysis, 
-then use the *_full.csv output and clean the data yourself by excluding 
-rows with cleaningcode > 1 which are the cases where no or invalid
-accelerometer data was present.
+then use the *_full.csv output and clean the night level data yourself
+by excluding  rows with cleaningcode > 1 which are the cases where no
+or invalid accelerometer data was present.
+
+The above means that for studies with missing sleeplog entries for some
+individuals and some nights using the *_full.csv output and excluding
+rows (nights) with cleaningcode > 1 will lead to the same as
+* _cleaned.csv plus sleep estimates for the nights with missing
+sleeplog, providing that there was enough accelerometer data for 
+those nights.
+
+In other words, *_cleaned.csv is perfect if you only want to rely on 
+nights with a sleeplog or if you do not use a sleeplog at all. For all
+other scenarios I advise using the *_full.csv report and to clean it 
+yourself.
 
 }
 \author{