Skip to content

Commit 2e7888c

Browse files
committed
small cleanup changes for CRAN submission
1 parent cb67e02 commit 2e7888c

6 files changed

+67
-4
lines changed

NEWS.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# LightLogR 0.5.3
22

3+
* small cleanup changes for CRAN submission
4+
35
# LightLogR 0.5.2
46

57
* passed 300 unit tests for `LightLogR` 🎉

R/import_LL.R

+17-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,23 @@
194194
#'
195195
#' Model: GENEActiv
196196
#'
197-
#' **Note:** This import function takes GENEActiv data that was preprocessed through the [GGIR](https://cran.r-project.org/web/packages/GGIR/vignettes/GGIR.html) package. By default, `GGIR` aggregates light data into intervals of 15 minutes. This can be set by the `windowsizes` argument in GGIR, which is a three-value vector, where the second values is set to 900 seconds by default. To import the preprocessed data with `LightLogR`, the `filename` argument requires a path to the parent directory of the GGIR output folders, specifically the `meta` folder, which contains the light exposure data. Multiple `filename`s can be specified, each of which needs to be a path to a different GGIR parent directory. GGIR exports can contain data from multiple participants, these will always be imported fully by providing the parent directory. Use the `pattern` argument to extract sensible `Id`s from the *.RData* filenames within the *meta/basic/* folder. As per the author, [Dr. Vincent van Hees](https://accelting.com/), GGIR preprocessed data are always in local time, provided the `desiredtz`/`configtz` are properly set in GGIR. `LightLogR` still requires a timezone to be set, but will not timeshift the import data.
197+
#' **Note:** This import function takes GENEActiv data that was preprocessed
198+
#' through the [GGIR]( https://cran.r-project.org/package=GGIR) package.
199+
#' By default, `GGIR` aggregates light data into intervals of 15 minutes. This
200+
#' can be set by the `windowsizes` argument in GGIR, which is a three-value
201+
#' vector, where the second values is set to 900 seconds by default. To import
202+
#' the preprocessed data with `LightLogR`, the `filename` argument requires a
203+
#' path to the parent directory of the GGIR output folders, specifically the
204+
#' `meta` folder, which contains the light exposure data. Multiple `filename`s
205+
#' can be specified, each of which needs to be a path to a different GGIR
206+
#' parent directory. GGIR exports can contain data from multiple participants,
207+
#' these will always be imported fully by providing the parent directory. Use
208+
#' the `pattern` argument to extract sensible `Id`s from the *.RData*
209+
#' filenames within the *meta/basic/* folder. As per the author,
210+
#' [Dr. Vincent van Hees](https://www.accelting.com), GGIR preprocessed data are
211+
#' always in local time, provided the `desiredtz`/`configtz` are properly set
212+
#' in GGIR. `LightLogR` still requires a timezone to be set, but will not
213+
#' timeshift the import data.
198214
#'
199215
#' ## MotionWatch 8
200216
#'

README.Rmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ To come:
4747

4848
- Integration of data into a unified database for cross-study analyses
4949

50-
##### Please note that LightLogR is work in progress! If you are interested in the project and want to know more, you can subscribe to the [LightLogR mailing list](https://lists.lrz.de/mailman/listinfo/lightlogr-users). If you find a bug or would like to see new or improved features, please open an issue on the [GitHub repository](https://github.com/tscnlab/LightLogR/issues).
50+
##### Please note that LightLogR is work in progress! If you are interested in the project and want to know more, you can subscribe to the [LightLogR mailing list](https://www.tscnlab.org/software). If you find a bug or would like to see new or improved features, please open an issue on the [GitHub repository](https://github.com/tscnlab/LightLogR/issues).
5151

5252
Have a look at the **Example** section down below to get started, or dive into the [Articles](https://tscnlab.github.io/LightLogR/articles/index.html) to get more in depth information about how to work with the package and generate images such as the one above, import data, visualization, and metric calculation.
5353

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ To come:
5959

6060
- Integration of data into a unified database for cross-study analyses
6161

62-
##### Please note that LightLogR is work in progress! If you are interested in the project and want to know more, you can subscribe to the [LightLogR mailing list](https://lists.lrz.de/mailman/listinfo/lightlogr-users). If you find a bug or would like to see new or improved features, please open an issue on the [GitHub repository](https://github.com/tscnlab/LightLogR/issues).
62+
##### Please note that LightLogR is work in progress! If you are interested in the project and want to know more, you can subscribe to the [LightLogR mailing list](https://www.tscnlab.org/software). If you find a bug or would like to see new or improved features, please open an issue on the [GitHub repository](https://github.com/tscnlab/LightLogR/issues).
6363

6464
Have a look at the **Example** section down below to get started, or
6565
dive into the

cran-comments.md

+29
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1+
## Submission Version 0.5.3
2+
3+
### R CMD check results
4+
5+
0 errors ✔ | 0 warnings ✔ | 3 notes ✖
6+
7+
* Note 1: Imports includes 22 non-default packages.
8+
This is correct and necessary
9+
10+
* Note 2: unable to verify current time.
11+
Time server seems to be unavailable
12+
13+
* Note 3: Found HTML validation problems.
14+
This note seems related to the testing environment and not the actual package.
15+
16+
### Windevel results
17+
18+
2 Notes
19+
20+
* Note: Author field differs from that derived from Authors@R.
21+
As far as I can tell, the only difference is that the Authors@R field has (ORCID: *Orcid URL*) behind the authors, where as the Author field has (*Orcid URL*). As this is automatically generated based on Description, I don't think I can influence that.
22+
23+
* Note: Examples with CPU (user + system) or elapsed time > 10s
24+
user system elapsed
25+
gg_photoperiod 12.52 1.72 14.25
26+
gg_doubleplot 9.45 1.39 10.85
27+
28+
These examples are expected to take a longer time, as they are plotting functions and several variants are shown in the examples.
29+
130
## Resubmission #3 (Version 0.3.8)
231

332
This is a resubmission. In this version I corrected the error in a symlog_trans example.

man/import_Dataset.Rd

+17-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)