-
Notifications
You must be signed in to change notification settings - Fork 31
/
README.Rmd
87 lines (62 loc) · 3.23 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
---
output: github_document
---
<!-- README.md is generated from README.Rmd as part of the CICD process. -->
<!-- Please edit README.Rmd - but you do not need to build it! -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
library(visR)
library(riskmetric)
library(usethis)
riskmetric_score <- "visR" %>%
riskmetric::pkg_ref() %>%
dplyr::as_tibble() %>%
riskmetric::pkg_assess() %>%
riskmetric::pkg_score() %>%
dplyr::pull("pkg_score") %>%
round(2)
```
# visR <img src='man/figures/logo.png' align="right" height="131.5" />
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://app.codecov.io/gh/openpharma/visR?branch=main)
[](https://github.com/openpharma/visR/actions)
[](https://CRAN.R-project.org/package=visR)
<a href=https://github.com/pharmaR/riskmetric><img src=https://img.shields.io/badge/riskmetric-`r riskmetric_score`-green></img></a>
<!-- badges: end -->
**Note**: We aim to keep visR maintained, but cannot commit to any future development. For all your KM plot needs, we would recommend checking out [ggsurvit](https://www.danieldsjoberg.com/ggsurvfit/).
The goal of visR is to enable fit-for-purpose, reusable clinical and medical research focused visualizations and tables with sensible defaults and based on sound [graphical principles](https://graphicsprinciples.github.io/).
[Package documentation](https://openpharma.github.io/visR/)
## Motivation
By using a common package for visualising data analysis results in the clinical development process, we want to have a **positive influence** on
* **choice of visualisation** by making it easy explore different visualisation and to use impactful visualisations fit-for-purpose
* effective visual communication by making it easy to **implement best practices**
We are not judging on what visualisation you chose for your research question, but want to facilitate and support good practice.
You can read more about the philosophy and architecture in the [repo wiki](https://github.com/openpharma/visR/wiki).
## Installation
The easiest way to get `visR` is to install from CRAN:
``` r
install.packages("visR")
```
Install the *development* version from [GitHub](https://github.com/openpharma/visR) with:
``` r
# defaults to main branch
devtools::install_github("openpharma/visR")
```
## Cite visR
```{text, comment="", eval = FALSE}
> citation("visR")
```
## Contributing
Please note that the `visR` project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
Thank you to all contributors:
```{r warning=FALSE, echo=FALSE, message=FALSE}
contr <- usethis::use_tidy_thanks("https://github.com/openpharma/visR", from = "2020-01-01", to = NULL)
```
`r unique(c(paste((paste0("[@",contr,"](https://github.com/", contr, ")")), collapse = ", ")
))`