-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathREADME.Rmd
86 lines (50 loc) · 3.24 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
out.width = "100%"
)
```
# sdtmchecks
<!-- package hex logo -->
<img src="man/figures/logo_em.png" alt="drawing" align="right" width="100"/>
<!-- badges: start -->
[](https://github.com/pharmaverse/sdtmchecks/actions/workflows/R-CMD-check.yml)
[](https://app.codecov.io/github/pharmaverse/sdtmchecks)
[](https://cran.r-project.org/package=sdtmchecks)
<!-- badges: end -->
The sdtmchecks package contains functions to identify common data issues in SDTM data. These checks are intended to be **generalizable**, **actionable**, and **meaningful for analysis**.
## Installation
### CRAN
You can install {sdtmchecks} from [CRAN](https://cran.r-project.org/):
``` r
install.packages("sdtmchecks")
```
### Development version (devel branch)
The development version (based on the default *devel branch*) can be installed via:
``` r
install.packages("sdtmchecks", repos = "https://pharmaverse.r-universe.dev")
```
Or, via [GitHub](https://github.com/) repo `pharmaverse/sdtmchecks@HEAD`:
``` r
# install.packages("devtools")
devtools::install_github("pharmaverse/sdtmchecks")
# Note that `ref = "devel"` is not needed since devel is the default branch
```
## Use the package
The [Get started page](https://pharmaverse.github.io/sdtmchecks/articles/sdtmchecks.html) walks you through how the package can be used.
## Data checks in the package
To search available data check functions, please see [this search page](https://pharmaverse.github.io/sdtmchecks/articles/search_checks.html).
The main data check functions of the package are saved as R program files beginning with **"check_..."** and are referenced under the [Data Checks](https://pharmaverse.github.io/sdtmchecks/reference/index.html#data-checks) portion of the Reference page.
## SDTM version
This package aims to be SDTM version agnostic and does not require users to specify the version.
## Contributing
This package has been developed internally at [Roche](https://www.roche.com/) since 2014. There may be areas where the checks expect Roche-specific SDTM implementation choices. Proposed additions or modifications should attempt to maintain generalizability for slightly different data standards across companies. For examples on how to do so and to learn more about contributing in general, please refer to the [Writing a New Check](https://pharmaverse.github.io/sdtmchecks/articles/write_a_check.html) page.
If you have an idea for a new check but no time for development, please [open an issue](https://github.com/pharmaverse/sdtmchecks/issues).
## FAQs
The package [FAQs](https://pharmaverse.github.io/sdtmchecks/articles/faqs.html) may provide additional information you are looking for. If not, please feel free to post your question as [an issue](https://github.com/pharmaverse/sdtmchecks/issues).