stRoke/README.md
2023-01-03 14:13:22 +01:00

27 lines
1.4 KiB
Markdown

<!-- badges: start -->
[![R-CMD-check](https://github.com/agdamsbo/stRoke/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/agdamsbo/stRoke/actions/workflows/R-CMD-check.yaml)
[![pages-build-deployment](https://github.com/agdamsbo/stRoke/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/agdamsbo/stRoke/actions/workflows/pages/pages-build-deployment)
<!-- badges: end -->
# stRoke package <img src="man/figures/hexlogo.png" align="right" />
This package contains tools used for my (Andreas) research work and for the ENIGMA project.
Please use the package or grab bits of the functions. Mind the licensing.
# A few notes
The function `generic_stroke()`can be used with `data(talos)` or a custom data set to illustrate the classic analysis of mRS outcome from stroke trials.
In documenting and testing the package, I have used [OpenAI's](https://beta.openai.com/overview) chatgpt with [gpttools](https://jameshwade.github.io/gpttools/). The chatgpt is an interesting tool, that is in no way perfect, but it helps with tedious tasks. Both `gpttools` and [`gptstudio`](https://michelnivard.github.io/gptstudio/) are interesting implementations in R and RStudio.
# Source
This package is [shared on GitHub](https://github.com/agdamsbo/stRoke), and you are very welcome to contribute by opening an issue or a pull request.
# Installation
The package can be installed from GitHub:
```
remotes::install_github("agdamsbo/stRoke")
```