forked from DOI-USGS/toxEval
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
159 lines (111 loc) · 6.88 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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
---
title: "README"
output:
md_document:
variant: markdown_github
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# toxEval <img src="man/figures/toxEval.png" alt="toxEval" class="logo" style="width:90px;height:auto;" align="right" />
[](https://cran.r-project.org/package=toxEval)
[](https://cran.r-project.org/package=toxEval)
[](https://cran.r-project.org/package=toxEval)
The `toxEval` R-package includes a set of functions to analyze, visualize, and organize measured concentration data as it relates to [https://www.epa.gov/comptox-tools/toxicity-forecasting-toxcast](https://www.epa.gov/comptox-tools/toxicity-forecasting-toxcast) or other user-selected chemical-biological interaction benchmark data such as water quality criteria. The intent of these analyses is to develop a better understanding of the potential biological relevance of environmental chemistry data. Results can be used to prioritize which chemicals at which sites may be of greatest concern. These methods are meant to be used as a screening technique to predict potential for biological influence from chemicals that ultimately need to be validated with direct biological assays.
The functions within this package allow great flexibly for exploring the potential biological affects of measured chemicals. Also included in the package is a browser-based application made from the `Shiny` R-package (the app). The app is based on functions within the R-package and includes many convenient analyses and visualization options for users to choose. Use of the functions within the R-package allows for additional flexibility within the functions beyond what the app offers and provides options for the user to interact more directly with the data. The overview in this document focuses on the R-package.
## Installation of toxEval
To install the toxEval package, you must be using R 3.0 or greater and run the following command:
```{r eval=FALSE}
install.packages("toxEval")
```
To get cutting-edge changes, install from GitHub using the `remotes` packages:
```{r eval=FALSE}
library(remotes)
install_gitlab("water/toxEval",
host = "code.usgs.gov",
build_vignettes = TRUE,
build_opts = c("--no-resave-data",
"--no-manual"),
dependencies = TRUE)
```
## Quickstart
Installation instructions are below. To quickly get going in `toxEval`, run:
```{r}
library(toxEval)
```
```{r eval=FALSE}
explore_endpoints()
```
<p align="center">
<img src="https://code.usgs.gov/water/toxEval/raw/main/man/figures/app.gif" alt="app_demo">
</p>
Then click on the "Load Example Data" in the upper right corner. This loads the example data that is found here:
```{r eval=FALSE}
file.path(system.file("extdata", package="toxEval"), "OWC_data_fromSup.xlsx")
```
Once the data is loaded in the app, sample R code is shown below each tab. This can be copied into the R console (once the app is stopped...) to use as a base for exploring the package directly in R.
Alternatively, an example workflow is shown here (also using example data provided in the package):
```{r warning=FALSE, fig.width=8}
library(toxEval)
path_to_file <- file.path(system.file("extdata", package="toxEval"), "OWC_data_fromSup.xlsx")
tox_list <- create_toxEval(path_to_file)
ACClong <- get_ACC(tox_list$chem_info$CAS)
ACClong <- remove_flags(ACClong)
cleaned_ep <- clean_endPoint_info(end_point_info)
filtered_ep <- filter_groups(cleaned_ep,
groupCol = 'intended_target_family',
remove_groups = c('Background Measurement','Undefined'))
chemicalSummary <- get_chemical_summary(tox_list,
ACClong,
filtered_ep)
######################################
chem_class_plot <- plot_tox_boxplots(chemicalSummary,
category = 'Chemical Class')
chem_class_plot
######################################
plot_stacks <- plot_tox_stacks(chemicalSummary,
tox_list$chem_site,
category = "Chemical Class")
plot_stacks
######################################
plot_heat <- plot_tox_heatmap(chemicalSummary,
tox_list$chem_site,
category = "Chemical Class",
font_size = 7)
plot_heat
```
This code opens up the example file, loads it into a `toxEval` object, grabs the pertinent ToxCast information, and creates a "chemicalSummary" data frame that is used in many of the plot and table functions.
There are 4 vignettes to help introduce and navigate the `toxEval` package:
|Name|R command|Description |
|----------|------------|-----------------------------------------|
|[Introduction](https://rconnect.usgs.gov/toxEval_docs/articles/Introduction.html) | `vignette("Introduction", package="toxEval")`|Introduction to the toxEval |
|[Basic Workflow](https://rconnect.usgs.gov/toxEval_docs/articles/basicWorkflow.html) | `vignette("basicWorkflow", package="toxEval")`|Quickstart guide to get overview of available functions |
|[Prepare Data](https://rconnect.usgs.gov/toxEval_docs/articles/PrepareData.html) | `vignette("PrepareData", package="toxEval")`|Guide to preparing your data for toxEval analysis|
|[Shiny App Guide](https://rconnect.usgs.gov/toxEval_docs/articles/shinyApp.html) | `vignette("shinyApp", package="toxEval")`|Guide to the toxEval shiny application|
### Reporting bugs
Please consider reporting bugs and asking questions on the Issues page:
[https://github.com/DOI-USGS/toxEval/issues](https://github.com/DOI-USGS/toxEval/issues)
### Code of Conduct
We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the [code of conduct](https://github.com/DOI-USGS/toxEval/blob/main/CONDUCT.md) for more information.
### Package Support
The Water and Environmental Health Mission Areas of the USGS, as well as the Great Lakes Restoration Initiative (GLRI) has supported the development of the `toxEval` R-package. Further maintenance is expected to be stable through September 2024. Resources are available primarily for maintenance and responding to user questions. Priorities on the development of new features are determined by the `toxEval` development team.
### Sunset date
Funding for `toxEval` is secured through summer 2025, after which bug fixes & new features will be minimal.
## Run toxEval
To run the toxEval app:
1. Open RStudio
2. In the Console (lower-left window of RStudio) paste the following:
```{r eval=FALSE}
library(toxEval)
explore_endpoints()
```
## Citing toxEval
```{r cite}
citation(package = "toxEval")
```
```{r disclaimer, child="DISCLAIMER.md", eval=TRUE}
```