Giter Site home page Giter Site logo

activanalyzer's Introduction

activAnalyzer

CRAN status Codecov test coverage Lifecycle: experimental R-CMD-check status

activAnalyzer is a Shiny app that has been developed to analyze daily physical behavior data recorded at the hip in adults using an ActiGraph accelerometer (.agd file from a GT3X, GT3X+, wGT3X+ or wGT3X-BT device). Once analysis is completed, the app allows exporting results to .csv files and generating a report of the measurement (in either an .html format or a .pdf format). All the configured inputs relevant for interpreting the results are recorded in the report. Be sure that the inputs that are configured when generating the report correspond to the analysis that was actually performed (in other words, avoid modifying the inputs after generating satisfactory results). In addition to an analysis of physical behavior, the app also allows to implement the Daily- and Clinical visit-PROactive Physical Activity in COPD (chronic obstructive pulmonary disease) instruments (D-PPAC and C-PPAC). Please read the user’s guide for details about how the app works.

Usage

There are three different ways to use the activAnalyzer app:

  • On the web via a shinyapps.io platform (stable version). For information, as indicated by RStudio, “shinyapps.io is secure-by-design. Each Shiny application runs in its own protected environment and access is always SSL encrypted”. Importantly, the app is hosted using a free account that allows to run apps for 25 hours per month. Thus, the availability of the app on the web is very dependent on the number of users as well as the time spent by each user on the app. Moreover, as computations when using the app can be quite intensive, it is possible that speed and stability of this online version of the app become sometimes compromised. For these reasons, this option should be considered as a way to have a quick look at how the app works. The other available options (please see below) will be more appropriate for working with the app on a regular basis. Of note, Google Chrome and Microsoft Edge browsers allow the app to work as expected but Mozilla Firefox does not seem to allow resetting all the inputs when required.
  • On your machine via a standalone desktop app that is downloadable from the SourceForge website (stable version, for Windows machines only). The standalone app has been developed using the framework DesktopDeployR made available by W. Lee Pang. Explanations related to this framework can be retrieved from a dedicated GitHub repository. Once the app is installed on your PC, you will have to double-click on the desktop app icon (if you chose this option during the installation process), which will run the R-portable version embedded in the app and then will launch the app in your default web browser with 127.0.0.1 as the value for the host parameter. This means that only your current machine will can access the app. You will can open only one session at a time. As written above, Google Chrome and Microsoft Edge browsers allow the app to work as expected but Mozilla Firefox does not seem to allow resetting all the inputs when required. Due to the extra work required to maintain such a format of the app up to date, it is not planned for the moment to provide updates for version 2.0.2 and newer versions.
  • On your machine via R software (version: $\ge$ 3.4.0), the RStudio environment, and the activAnalyzer package installable from CRAN (stable version) or from GitHub (development version). With version 2.0.1 and former versions, the app is launched in the RStudio window by default. For these versions, unfortunately only the RStudio version called Prairie Trillium [2022.02] and former versions allow to correctly quit the app from the RStudio window. Since version 2.0.2, the app is launched in the default web browser by default and could be used with the latest RStudio version (hopefully) without problems. Whatever the version used, to be able to generate a .pdf report, you will have to install the TinyTeX distribution. The first time you will generate a .pdf report, you will have to wait some time so that the required packages are installed on your machine. In short, after installing R and RStudio, you can run the following command lines in the RStudio console:
# For CRAN version:

## Code for installing the activAnalyzer package (stable version)
install.packages("activAnalyzer")

## Code for installing the TinyTex distribution
install.packages("tinytex")
tinytex::install_tinytex()
# For development version:

## Code for installing the activAnalyzer package (development version)
install.packages("devtools")
devtools::install_github("pydemull/activAnalyzer")

## Code for installing the TinyTex distribution
install.packages("tinytex")
tinytex::install_tinytex()

Example

To launch the app using R:

library(activAnalyzer)
activAnalyzer::run_app()

Code of Conduct

Please note that the activAnalyzer project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

activanalyzer's People

Contributors

pydemull avatar

Stargazers

 avatar  avatar  avatar  avatar

Forkers

lucaz01

activanalyzer's Issues

Release activAnalyzer 2.1.0

Prepare for release:

  • git pull
  • Check current CRAN check results
  • Polish NEWS
  • urlchecker::url_check()
  • devtools::build_readme()
  • devtools::check(remote = TRUE, manual = TRUE)
  • devtools::check_win_devel()
  • revdepcheck::revdep_check(num_workers = 4)
  • Update cran-comments.md
  • git push
  • Draft blog post

Submit to CRAN:

  • usethis::use_version('minor')
  • devtools::submit_cran()
  • Approve email

Wait for CRAN...

  • Accepted 🎉
  • Add preemptive link to blog post in pkgdown news menu
  • usethis::use_github_release()
  • usethis::use_dev_version(push = TRUE)
  • Finish blog post
  • Tweet

Problem with total kcal and pal for analysis using a part of the day only

The app allows to perform analyses and to get metrics in relation to a precise part of the day. Kcal and PAL appear to be correctly computed when using the wole day but not when using a shorter part of the day. The problem is that some computations are initially based on a 24-h basis without the possibility to be adapted on a shorter period. This should be fixed.

Limited gender category

The current gender field has the following types:

  • male
  • female
  • undefined

Ideally these types should be more inclusive. Non-binary individuals are best not phrased at undefined. This post contains some nice suggestions.

Screenshot 2022-09-30 at 23 40 11

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.