mirror of
https://github.com/agdamsbo/FreesearchR.git
synced 2025-09-12 18:09:39 +02:00
73 lines
3.1 KiB
Markdown
73 lines
3.1 KiB
Markdown
# freesearcheR
|
|
|
|
<!-- badges: start -->
|
|
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
|
|
[](https://github.com/agdamsbo/freesearcheR/actions/workflows/rhub.yaml)
|
|
[](https://doi.org/10.5281/zenodo.14527429)
|
|
[](https://agdamsbo.shinyapps.io/freesearcheR/)
|
|
<!-- badges: end -->
|
|
|
|
This package is the backbone of the ***freesearcheR***, a free and open-source browser based data exploration and analysis tool for clinicians and researchers with publication ready output.
|
|
|
|
This package and the ***freesearcheR***-tool is part of a larger initiative to democratize health data analysis and remove barriers for clinicians to engage in health research.
|
|
|
|
the ***freesearcheR***-tool is online and accessible here: [link to the app freely hosted on shinyapps.io](https://agdamsbo.shinyapps.io/freesearcheR/). All feedback is welcome and can be shared as a GitHub issue.
|
|
|
|
Initiatives for funding continued development of the tool and surrounding initiatives is ongoing.
|
|
|
|
## Roadmap
|
|
|
|
The current state of the app is considered experimental, and a lot of things are still changing. It is, however, in a usable state, with basic functions available to the user.
|
|
|
|
Below are some (the actual list is quite long and growing) of the planned features and improvements:
|
|
|
|
- [ ] Stratified analyses
|
|
|
|
- Additional study designs:
|
|
|
|
- [x] Cross-sectional data analyses
|
|
|
|
- [ ] Longitudinal data analyses
|
|
|
|
- [ ] Survival analysis
|
|
|
|
- More detailed variable browser
|
|
|
|
- [x] Add histograms for data distribution. 2025-01-16
|
|
|
|
- [x] Option to edit labels. 2025-01-16
|
|
|
|
- More output controls
|
|
|
|
- [ ] Theming output tables
|
|
|
|
- [ ] Select analyses to include in report
|
|
|
|
- [ ] Plot regression analyses results
|
|
|
|
- [x] Export modified data. 2025-01-16
|
|
|
|
- [ ] Include reproducible code for all steps
|
|
|
|
- [x] ~~Modify factor levels~~ Factor level modifications is possible through converting factors to numeric > cutting numeric with desired fixed values. 2024-12-12
|
|
|
|
- [x] More options for date/datetime/time grouping/factoring. Included weekday and month-only options. 2024-12-12
|
|
|
|
|
|
## Install locally
|
|
|
|
The ***freesearcheR***-tool can also be launched locally. Any data.frame available in the global environment will be accessible from the interface.
|
|
|
|
```
|
|
require("devtools")
|
|
devtools::install_github("agdamsbo/freesearcheR")
|
|
library(freesearcheR)
|
|
# By loading mtcars to the environment, it will be available
|
|
# in the interface like any other data.frame
|
|
data(mtcars)
|
|
shiny_freesearcheR()
|
|
```
|
|
|
|
## Code of Conduct
|
|
|
|
Please note that the freesearcheR project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
|