-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
53 lines (38 loc) · 1.45 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# OncoRegimenFinder <img src="man/figures/logo.png" align="right" alt="" width="120" />
<!-- badges: start -->
<!-- badges: end -->
This package extracts Chemotherapy Regimens from the OMOP CDM Drug Exposures Table based on an algorithm developed by the OHDSI Oncology Workgroup.
## Installation
The development version can be installed from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("meerapatelmd/oncoregimenfinder")
```
## Example Run
OncoRegimenFinder requires:
* A connection to an OMOP CDM Instance (`conn`)
* A designated schema where the results can be written to (`writeDatabaseSchema`)
```{r params}
cdmDatabaseSchema <- "omop_cdm_2"
writeDatabaseSchema <- "oncoregimenfinder"
```
Execution performed by a single function call to `runORF()`
```{r run,eval=FALSE}
runORF(conn = conn,
cdmDatabaseSchema = cdmDatabaseSchema,
writeDatabaseSchema = writeDatabaseSchema)
```
## Code of Conduct
Please note that the OncoRegimenFinder project is released with a [Contributor Code of Conduct](https://github.mskcc.org/pages/patelm9/OncoRegimenFinder/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.