TikatuWQ is an open-source R package designed to
analyze, visualize, and report water quality data according to Brazilian
environmental standards.
It implements the main indices used in the country
IQA/NSFWQI and IET (Carlson and
Lamparelli) and provides automated checks for CONAMA
Resolution 357/2005 compliance.
The package also includes trend analysis, data validation, and automatic
report generation.
📄 Ler em Português
To install development dependencies and check the package locally:
install.packages(c("devtools","testthat","rmarkdown","ggplot2","dplyr","tidyr",
"readr","lubridate","stringr","glue","scales","broom","purrr"))
::load_all("tikatuwq")
devtools::check("tikatuwq") devtools
<- read_wq(system.file("extdata","exemplo_chamagunga.csv", package="tikatuwq")) |>
df validate_wq() |>
iqa(na_rm = TRUE)
plot_iqa(df)
# Analytical text (rule-based)
<- generate_analysis(df, classe_conama = "2",
pars incluir_tendencia = TRUE,
parametros_tendencia = c("turbidez","od","pH"),
contexto = list(river="Chamagunga", period="2025-07"))
cat(paste(pars, collapse = "\n\n"))
The TikatuWQ package was developed by
VinÃcius Saraiva Santos (author and maintainer)
as part of the Tikatu Research Project, conducted
within the Nucleus for Research in Tropical Ecosystems –
NuPEcoTropic, a research group linked to the Federal
University of Southern Bahia (UFSB) and coordinated by
Prof. Dr. FabrÃcio Berton Zanchi.
This work was carried out as part of the activities of the Postgraduate Program in Biosystems (PPG Biossistemas) at UFSB, under the supervision of Prof. Dr. FabrÃcio Berton Zanchi.
The Tikatu Project, developed and coordinated by VinÃcius Saraiva Santos, integrates research focused on environmental monitoring and modeling.
DOI
,
Citation
) from DESCRIPTION
.inst/CITATION
to use bibentry()
(replacing deprecated citEntry()
).param_analysis()
and
param_analysis_multi()
:
plot_trend()
and
plot_map()
(controlled messages).devtools::check()
validations passed
without errors.generate_analysis()
documentation.id_cols
and
filter
to match current signature.README-pt.md
, now converted to
absolute HTTPS URL.plot_trend()
for temporal trend analysis:
ggplot
object ready for visualization or
reports.plot_map()
for spatial visualization of
sampling sites.generate_analysis()
— automatic rule-based analytical
paragraphs.iet_lamparelli()
and
nsfwqi()
.install.packages("remotes") # or devtools
::install_github("tikatuwq/tikatuwq", dependencies = TRUE)
remotes
# stable version (by tag)
::install_github("tikatuwq/tikatuwq@v0.7.0", build_vignettes = TRUE) remotes
<- read_wq(system.file("extdata","exemplo_chamagunga.csv", package="tikatuwq"))
df
# Table with only violations, ready for report
conama_report(df, "2", only_violations = TRUE, pretty = TRUE)
# Short textual summary
cat(paste(conama_text(df, "2", only_violations = TRUE), collapse = "\n"))
read_wq(path)
— reads water quality datasets
(CSV).validate_wq(df)
— validates/normalizes columns and
units.iqa(df, na_rm = TRUE, ...)
— Water Quality Index
(CETESB/NSF).iet_carlson(df)
/ iet_lamparelli(df)
—
Trophic State Index.nsfwqi(df)
— NSFWQI (framework ready).conama_limits(class)
— limits from CONAMA 357/2005
Resolution.conama_check(df, class)
— compliance by parameter (*_ok
columns).plot_iqa()
, plot_series()
,
plot_box()
, plot_heatmap()
,
plot_map()
, plot_trend()
(returns
ggplot
object).generate_analysis()
,
render_report()
.system.file("extdata", "exemplo_chamagunga.csv", package = "tikatuwq")
.citation("tikatuwq")
If you use tikatuwq in your research, please cite it as follows:
Santos, V. S. (2025). tikatuwq: Water Quality Assessment and Environmental Compliance in Brazil (v0.7.0). Zenodo. https://doi.org/10.5281/zenodo.17407297
BibTeX entry:
@Manual{Santos2025tikatuwq,
title = {tikatuwq: Water Quality Assessment and Environmental Compliance in Brazil},
author = {Vinicius Saraiva Santos},
year = {2025},
note = {R package version 0.7.0},
doi = {10.5281/zenodo.17407297},
url = {https://github.com/tikatuwq/tikatuwq},
}