gilesjohnr / WES

WES: an R package providing methods for analyzing Wastewater and Environmental Sampling (WES) data.
https://www.r-wes.com
Creative Commons Attribution 4.0 International
0 stars 0 forks source link

CRAN status metacran downloads R-CMD-check pages-build-deployment pkgdown

WES: an R package for Analyzing Environmental Sampling Data

The 'WES' R package provides reproducible functions for collating and analyzing data from wastewater and environmental sampling studies. Wastewater and Environmental Sampling (WES) of infectious diseases involves collecting samples from various sources (such as sewage, water, air, soil, or surfaces) to monitor the presence of pathogens in the environment. The tools here are intended to do the heavy lifting when analyzing WES data and include:

We developed the 'WES' R package primarily for epidemiological surveillance studies for multiple pathogens in Low- and Middle-Income Countries (LMIC) where samples are collected from informal sewer networks. However, the functions should generalize to other applications provided they use the same data formats. Feel free to reach out with comments or questions; the package is currently in development and maintained by John Giles (@gilesjohnr).

\

Data standards

To use the data and methods provided in the 'WES' R package, input data must match the formatting shown in the template_WES_data and template_WES_standard_curves data objects. Both template data sets are described in more detail in the following vignette:

[Templates for input data sets](https://gilesjohnr.github.io/WES/articles/template_WES_data.html)

\

Derivative qPCR quantities

Studies utilizing environmental sampling for disease surveillance often employ Quantitative Real-Time Polymerase Chain Reaction (qPCR) to detect pathogens in samples. In qPCR, the measurement is given as the cycle threshold (Ct) value which is often used with a cutoff value to render a presence/absence response. The Ct values can also be transformed into absolute or relative quantities of pathogen presence using the methods in the calc_n_copies(), calc_delta_delta_ct(), and est_amplification_efficiency() functions which are described in more detail in the following vignettes:

[Absolute quantification of qPCR data](https://gilesjohnr.github.io/WES/articles/derivative_quantities.html#absolute-quantification-calculating-the-number-of-target-gene-copies)
[Relative quantification of qPCR data](https://gilesjohnr.github.io/WES/articles/derivative_quantities.html#relative-quantification-calculating-the-fold-change-in-gene-expression)
[qPCR Amplification efficiency](https://gilesjohnr.github.io/WES/articles/amplification_efficiency.html)

\

Covariates

Wastewater and Environmental Sampling studies conducted in informal sewer systems are vulnerable to confounding because the climate and local geography can impact the substrate available for collection. Therefore, we have included functions that download spatial data (such as climate, hydrology, and local populations) for the times and locations in the WES data. The following vignettes describe the data sources and methods used and relate these spatial data to WES data observations:

[Sources of spatial data](https://gilesjohnr.github.io/WES/articles/metadata_functions.html)
[Getting climate data](https://gilesjohnr.github.io/WES/articles/get_climate_data.html)
[Calculating hydrological variables](https://gilesjohnr.github.io/WES/articles/calc_hydro_variables.html)
[Calculating local population size](https://gilesjohnr.github.io/WES/articles/calc_local_population.html)
[Getting administrative data](https://gilesjohnr.github.io/WES/articles/get_admin_data.html)

\

Analysis

Additional analyses are under development and will likely include the calculation of cross-correlations among targets, time series models, and models of pathogen presence based on multiple gene targets. Currently, methods for quick tabulation of sampling statistics and overall detection rates are available in the calc_sample_sizes() function.

\

Visualization

We are currently developing an RShiny application that will visualize the data and methods in the 'WES' package.

\

Installation

Use the devtools package to install the development version of 'WES' from the GitHub repository. R version >= 4.1.1 recommended.

# The WhiteboxTools R frontend is a prerequisite for GIS functionality
install.packages("whitebox", dependencies = TRUE)
whitebox::install_whitebox()
whitebox::wbt_version()

# Install the current CRAN version
install.packages("WES", dependencies = TRUE)

# Or install the development version from GitHub
install.packages('devtools')
devtools::install_github("gilesjohnr/WES", dependencies=TRUE)

\

Troubleshooting

For general questions, contact John Giles (john.giles@gatesfoundation.org) and/or Jillian Gauld (jillian.gauld@gatesfoundation.org). Note that this software is made available under a Creative Commons 4.0 license and was developed for specific environmental sampling applications and therefore may not generalize perfectly to all settings.

\

Funding

This work was developed at the Institute for Disease Modeling in support of funded research grants made by the Bill \& Melinda Gates Foundation.