
<!-- README.md is generated from README.Rmd. Please edit that file -->

# GeoTox <a href="https://github.com/NIEHS/GeoTox"><img src="man/figures/logo.svg" align="right" height="139" alt="GeoTox website" /></a>

## Maintainer

Messier, Kyle (NIH/NIEHS) <kyle.messier@nih.gov>

<!-- badges: start -->

[![Project Status: Active – The project has reached a stable, usable
state and is being actively
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R-CMD-check](https://github.com/NIEHS/GeoTox/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/NIEHS/GeoTox/actions/workflows/R-CMD-check.yaml)
[![pkgdown](https://github.com/NIEHS/GeoTox/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/NIEHS/GeoTox/actions/workflows/pkgdown.yaml)
[![cov](https://NIEHS.github.io/GeoTox/badges/coverage.svg)](https://github.com/NIEHS/GeoTox/actions)
[![CRAN
status](https://www.r-pkg.org/badges/version/GeoTox)](https://CRAN.R-project.org/package=GeoTox)

<!-- badges: end -->

`GeoTox` is an open-source R software package for characterizing the
risk of perturbing molecular targets involved in adverse human health
outcomes based on exposure to spatially-referenced stressor mixtures via
the GeoTox framework - otherwise known as source-to-outcome-continuum
modeling. The package, methods, and case-studies are described in
[Messier, Reif, and Marvel, 2025, Human
Genomics](https://doi.org/10.1186/s40246-024-00711-8).

The GeoTox framework was first described in [Eccles et al. A geospatial
modeling approach to quantifying the risk of exposure to environmental
chemical mixtures via a common molecular target. Sci Total Environ. 2023
Jan 10;855:158905.](https://pubmed.ncbi.nlm.nih.gov/36152849/)

## Installation

The current stable version of the package can be installed from CRAN.

``` r
install.packages("GeoTox")
```

The previous implementation of the package, which uses in-memory storage
instead of DuckDB, can be installed by specifying the version.

``` r
#install.packages("pak")
pak::pak("GeoTox@0.3.0")
```

## Development Version

The development version can be installed from GitHub.

``` r
#install.packages("pak")
pak::pak("NIEHS/GeoTox@dev")
```

## Overview

Figure 1 below shows the steps in the source-to-outcome-continuum or
GeoTox modeling framework that is capable in the `GeoTox` package. The
`GeoTox` package uses R S3 object-oriented programming to create the
**GeoTox** object. The **GeoTox** object contains all of the information
required to run the analysis including tracking exposure, assays,
dose-response, and geospatial referencing. Each component of the object
and pipeline are stored in a relational DuckDB​​ database.

<p align="center">

<img src="man/figures/GeoTox.png" alt="GeoTox"> <br> <em>Figure 1:
Overview of the steps in the GeoTox framework</em>
</p>

## Getting Started

Please refer to the [package website](https://niehs.github.io/GeoTox/)
for a detailed description of how to use `GeoTox`. The development
version can be accessed [here](https://niehs.github.io/GeoTox/dev/).

## Citation

For citation information, please refer to our [CITATION
file](inst/CITATION).

## Issues and Contributions

To add or edit functionality, open a pull request into the main branch
with a detailed description of the proposed changes. Pull requests must
pass all status checks, and then will be approved or rejected by the
GeoTox maintainers.

Utilize [GitHub issues](https://github.com/NIEHS/GeoTox/issues) to
notify the authors of bugs, questions, or recommendations. Identify each
issue with the appropriate label to help ensure a timely response.
