Skip to content

Commit

Permalink
added sources for LightLogR: Github Repo, Zenodo Archive, CRAN, Website
Browse files Browse the repository at this point in the history
  • Loading branch information
JZauner committed Oct 7, 2024
1 parent 9e0019a commit 12e9753
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 6 deletions.
Binary file added paper/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions paper/paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ @article{biller2024
keywords = {individual sleep differences, naturalistic conditions, photoperiod, prospective cohort study, season, sleep architecture, sleep variability},
}

@misc{cran,
author = {{Zauner}, {Johannes} and {Hartmeyer}, Steffen L. and {Spitschan}, {Manuel}},
title = {{L}ight{L}og{R}: {P}rocess {D}ata from {W}earable {L}ight {L}oggers and {O}ptical {R}adiation {D}osimeters. CRAN Package},
howpublished = {\url{https://doi.org/10.32614/CRAN.package.LightLogR}},
year = {2024},
note = {[Accessed 07-10-2024]},
}

@article{devries2024,
author = {de Vries, SW and Gkaintatzi-Masouti, M and van Duijnhoven, J and Mardaljevic, J and Aarts, MPJ},
title = {Recommendations for light-dosimetry field studies based on a meta-analysis of personal light levels of office workers},
Expand All @@ -21,6 +29,14 @@ @article{devries2024
year = {2024}
}

@misc{documentation,
author = {{Zauner}, {Johannes} and {Hartmeyer}, Steffen L. and {Spitschan}, {Manuel}},
title = {{L}ight{L}og{R}: {P}rocess {D}ata from {W}earable {L}ight {L}oggers and {O}ptical {R}adiation {D}osimeters. {D}ocumentation and Tutorials},
howpublished = {\url{https://tscnlab.github.io/LightLogR/index.html}},
year = {2023},
note = {[Accessed 07-10-2024]},
}

@article{guidolin2024,
author = {Guidolin, Carolina and Aerts, Sam and Agbeshie, Gabriel Kwaku and Akuffo, Kwadwo Owusu and Aydin, Sema Nur and Baeza Moyano, David and Bolte, John and Broszio, Kai and Cantarero-Garc{\'\i}a, Guadalupe and Didikoglu, Altug and Gonz{\'a}lez-Lezcano, Roberto Alonso and Joosten-Ma, Hongli and Melero-Tur, Sofia and Nilsson Tengelin, Maria and P{\'e}rez Guti{\'e}rrez, Mar{\'\i}a Concepci{\'o}n and Stefani, Oliver and Svensson, Ingemar and Udovicic, Ljiljana and Zauner, Johannes and Spitschan, Manuel},
title = {Protocol for a prospective, multicentre, cross-sectional cohort study to assess personal light exposure [preprint]},
Expand Down Expand Up @@ -61,6 +77,14 @@ @article{migueles2019
url = {https://doi.org/10.1123/jmpb.2018-0063}
}

@software{repo,
title = {{L}ight{L}og{R}: {P}rocess {D}ata from {W}earable {L}ight {L}oggers and {O}ptical {R}adiation {D}osimeters. Github Repository},
author = {{Zauner}, {Johannes} and {Hartmeyer}, Steffen L. and {Spitschan}, {Manuel}},
version = {v0.4.1},
year = {2023},
url = {https://github.com/tscnlab/LightLogR}
}

@article{roguski2024,
author = {Roguski, A and Needham, N and MacGillivray, T and Martinovic, J and Dhillon, B and Riha, RL and Armstrong, L and Campbell, IH and Ferguson, A and Hilgen, G and Lako, M and Ritter, P and Santhi, N and von Schantz, M and Spitschan, M and Smith, DJ},
title = {Investigating light sensitivity in bipolar disorder ({HELIOS-BD})},
Expand Down Expand Up @@ -135,3 +159,14 @@ @article{zauner2023
doi = {10.21203/rs.3.rs-3771881/v1},
year = {2023}
}

@software{zenodo,
author = {{Zauner}, {Johannes} and {Hartmeyer}, Steffen L. and {Spitschan}, {Manuel}},
title = {tscnlab/LightLogR: v0.4.1. Archive},
month = sep,
year = 2024,
publisher = {Zenodo},
version = {v0.4.1},
doi = {10.5281/zenodo.13839724},
url = {https://doi.org/10.5281/zenodo.13839724}
}
14 changes: 8 additions & 6 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,23 @@ Light plays an important role in human health and well-being, which necessitates

# Statement of need

![LightLogR logo \label{fig:one}](logo.png){width="25%"}

Personalized luminous exposure data is progressively gaining importance across various domains, including research, occupational affairs, and lifestyle tracking. Data are collected through a proliferating selection of wearable light loggers and dosimeters, varying in size, shape, functionality, and output format [@hartmeyer2023]. Despite or potentially because of numerous use cases, the field still lacks a unified framework for collecting, validating, and analyzing the accumulated data [@hartmeyer2023; @spitschan2022]. This issue increases the time and expertise necessary to handle such data and also compromises the FAIRness (findability, accessibility, interoperability, reusability) [@wilkinson2016] of the results, especially for meta-analyses [@devries2024].

`LightLogR` was designed to be used by researchers who deal with personal light exposure data collected from wearable devices. These data are of interest for various disciplines, including chronobiology, sleep research, vision science and epidemiology, as well as for post-occupancy evaluations in architecture and lighting design. The package is intended to streamline the process of importing, processing, and analysing these data in a reproducible and transparent manner.
`LightLogR` (\autoref{fig:one}) was designed to be used by researchers who deal with personal light exposure data collected from wearable devices. These data are of interest for various disciplines, including chronobiology, sleep research, vision science and epidemiology, as well as for post-occupancy evaluations in architecture and lighting design. The package is intended to streamline the process of importing, processing, and analysing these data in a reproducible and transparent manner. The package is available on GitHub (@repo) and CRAN (@cran), has a dedicated website for documentation and tutorials (@documentation), and releases are archived on Zenodo (@zenodo).

`LightLogR`'s key features include:

- a growing list of supported devices with pre-defined import functions tailored to their data structure (17 at the time of writing, see \autoref{tab:one}),

- preprocessing functions to combine different time series, aggregate and filter data, and find and deal with implicitly missing data,

- visualization functions to quickly explore the data. These function are based on the popular `ggplot2` [@wickham2016] plotting package and are designed to be easily customizable to construct publication-ready figures (see, e.g., \autoref{fig:one}),
- visualization functions to quickly explore the data. These function are based on the popular `ggplot2` [@wickham2016] plotting package and are designed to be easily customizable to construct publication-ready figures (see, \autoref{fig:two}),

- a large and growing set of metrics that cover most if not all major approaches found in the literature (at the time of writing 61 metrics across 17 metric families, see \autoref{tab:two})), accessible via a consistent function interface.

![Light logger data can powerfully convey insights into personal light exposure and health-related outcomes. `LightLogR` facilitates the import and combination of different data sources into a coherent data structure, as seen here by combining environmental daylight availability and personal light exposure with data from a sleep diary. The visualization functions in the package further allow customization to produce publication-ready figures. \label{fig:one}](Day.png){width="80%"}
![Light logger data can powerfully convey insights into personal light exposure and health-related outcomes. `LightLogR` facilitates the import and combination of different data sources into a coherent data structure, as seen here by combining environmental daylight availability and personal light exposure with data from a sleep diary. The visualization functions in the package further allow customization to produce publication-ready figures. This figure was created with the 'gg_day()' function. The creation process is part of a tutorial [@documentation] on several key functions in the package \label{fig:two}](Day.png){width="80%"}

| Device Name | Manufacturer |
|----|----|
Expand Down Expand Up @@ -133,9 +135,9 @@ LightLogR is already being used in several research projects across scientific d

# Funding Statement

The development of `LightLogR` is funded by MeLiDos, a joint, EURAMET-funded project involving sixteen partners across Europe, aimed at developing a metrology and a standard workflow for wearable light logger data and optical radiation dosimeters. Its primary contributions towards fostering FAIR data include the development of a common file format, robust metadata descriptors, and an accompanying open-source software ecosystem.
The development of `LightLogR` is funded by MeLiDos, a joint, EURAMET-funded project involving sixteen partners across Europe, aimed at developing a metrology and a standard workflow for wearable light logger data and optical radiation dosimeters [@spitschan2024]. Its primary contributions towards fostering FAIR data include the development of a common file format, robust metadata descriptors, and an accompanying open-source software ecosystem.

The project (22NRM05 MeLiDos) [@spitschan2024] has received funding from the European Partnership on Metrology, co-financed from the European Union’s Horizon Europe Research and Innovation Programme and by the Participating States. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or EURAMET. Neither the European Union nor the granting authority can be held responsible for them.
The project (22NRM05 MeLiDos) has received funding from the European Partnership on Metrology, co-financed from the European Union’s Horizon Europe Research and Innovation Programme and by the Participating States. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or EURAMET. Neither the European Union nor the granting authority can be held responsible for them.

# Acknowledgements

Expand Down
Binary file modified paper/paper.pdf
Binary file not shown.

0 comments on commit 12e9753

Please sign in to comment.