https://github.com/jumpingrivers/utvizsunburst
https://github.com/jumpingrivers/utvizsunburst
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jumpingrivers/utvizsunburst
- Owner: jumpingrivers
- License: other
- Created: 2022-08-22T13:21:01.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-13T16:21:23.000Z (almost 4 years ago)
- Last Synced: 2025-03-05T10:19:08.730Z (over 1 year ago)
- Language: R
- Size: 168 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# utVizSunburst
The goal of {utVizSunburst} is to provide R users the ability to generate interactive sunburst plots
for displaying retention and admission data.
## Installation
You can install the development version of utVizSunburst like so:
``` r
remotes::install_gitlab("jumpingrivers/projects/uta/ard/utvizsunburst")
```
## Example
Please see the vignettes for an example of how to use utVizSunburst.
## For developers
### Precommit
Hooks for ensuring code style issues and other book-keeping tasks are corrected at an early stage
are provided. To use these you will need a local copy of both the python
[precommit tool](https://pre-commit.com/) and the R
[{precommit} package](https://github.com/lorenzwalthert/precommit/).
This uses various other R packages (styler, lintr etc) that must be installed in your R environment.
At present, {styler} is configured to it's second-most stringent level (`scope = "line_breaks"`)
and as such will not modify any symbols in your code.
### Tests
Unit tests should be defined using testthat.
### Features
All major features should be demonstrated in the vignette titled "Using utVizSunburst".