Package: tikatuwq 0.11.0

Vinicius Saraiva Santos

tikatuwq: Water Quality Assessment and Environmental Compliance in Brazil

Tools to import, clean, validate, and analyze freshwater quality data in Brazil. Implements water quality indices including the Water Quality Index ('WQI'/'IQA') using the weighted geometric mean following 'CETESB' methodology, an independent engine reproducing the 'IQA' of the Minas Gerais water agency 'IGAM' (a documented reproduction, not endorsed by the agency), paired comparison of 'IQA' engines with compare_iqa(), the Trophic State Index ('TSI'/'IET') after Carlson (1977) <doi:10.4319/lo.1977.22.2.0361> and Lamparelli (2004) <https://teses.usp.br/teses/disponiveis/41/41134/tde-20032006-075813/publico/TeseLamparelli2004.pdf>, and the National Sanitation Foundation Water Quality Index ('NSF WQI', Brown (1970)). The package also checks compliance with Brazilian standard 'CONAMA' Resolution 357/2005 <https://conama.mma.gov.br/?id=450&option=com_sisconama&task=arquivo.download> including the legal frequency rule (Art. 15, 80% conformity over six or more samples per year), and provides seasonal analysis with regional flow-season calendars, pollutant load computation, exceedance probability estimation, 'IET' visualization, and multivariate 'PCA' tools for routine monitoring workflows. The example dataset ('wq_demo') is a real subset from 'INEMA' monitoring data from a river in Bahia, Brazil (2020-2024).

Authors:Vinicius Saraiva Santos [aut, cre], Fabricio Berton Zanchi [ctb]

tikatuwq_0.11.0.tar.gz
tikatuwq_0.11.0.zip(r-4.7-any)tikatuwq_0.11.0.zip(r-4.6-any)tikatuwq_0.11.0.zip(r-4.5-any)
tikatuwq_0.11.0.tgz(r-4.6-any)tikatuwq_0.11.0.tgz(r-4.5-any)
tikatuwq_0.11.0.tar.gz(r-4.7-any)tikatuwq_0.11.0.tar.gz(r-4.6-any)
tikatuwq_0.11.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
tikatuwq/json (API)

# Install 'tikatuwq' in R:
install.packages('tikatuwq', repos = c('https://tikatuwq.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/tikatuwq/tikatuwq/issues

Pkgdown/docs site:https://tikatuwq.github.io

Datasets:
  • wq_demo - Example water quality dataset

On CRAN:

Conda:

5.30 score 1 stars 22 scripts 415 downloads 46 exports 43 dependencies

Last updated from:49b6683aa1. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK195
source / vignettesOK240
linux-releaseOK200
macos-releaseOK218
macos-oldrelOK200
windows-develOK131
windows-releaseOK98
windows-oldrelOK127
wasm-releaseOK132

Exports:assign_seasonbalnear_checkclassify_iqaclassify_tsi_carlsonclassify_tsi_lamparelliclean_unitscompare_iqacompare_seasonscompute_loadconama_checkconama_freq_checkconama_limitsconama_reportconama_summaryconama_textexceedance_probfix_coordsgenerate_analysisiet_carlsoniet_lamparelliiqaiqa_componentsiqa_methodsmk_seasonalnormalize_param_namesnsfwqiparam_plotparam_plot_multiparam_summaryparam_summary_multiparam_trendparam_trend_multiplot_boxplot_heatmapplot_ietplot_iqaplot_mapplot_map_qualityplot_seriesplot_trendread_wqrender_reportresume_wqtrend_paramvalidate_wqwq_pca

Dependencies:backportsbitbit64broomclicliprcpp11crayondplyrfarvergenericsggplot2gluegtablehmsisobandlabelinglifecyclelubridatemagrittrpillarpkgconfigprettyunitsprogresspurrrR6RColorBrewerreadrrlangS7scalesstringistringrtibbletidyrtidyselecttimechangetzdbutf8vctrsviridisLitevroomwithr

tikatuwq: basic workflow
Load package and demo dataset | Compute IQA and check CONAMA compliance | Summaries and plots | Render a report (writes to a temporary directory) | Interactive maps (plot_map)
Rendered fromtikatuwq.Rmdusingknitr::rmarkdown

Last update: 2026-10-16
Started: 2025-09-27

tikatuwq: From raw water quality data to CONAMA report
Introduction | Package overview and included real data | Reading and validating water quality data | Handling censored values (ND / | Cleaning units and basic QA/QC | Computing indices (IQA and trophic state) | Water Quality Index (IQA) | Trophic State Index (IET) | Checking CONAMA 357/2005 compliance | Summary and reports | Generating plots | IQA visualization | Time series | Box plots | Heatmap | Generating a textual analysis and report | Summary and next steps | Next steps
Rendered fromtikatuwq-workflow.Rmdusingknitr::rmarkdown

Last update: 2026-10-16
Started: 2025-11-16

tikatuwq: Water Quality Indices and Temporal Trends
Introduction | Water Quality Index (IQA/WQI) | Method overview | Default parameters and weights | Computing IQA | Handling missing parameters | Custom weights | Classification | Trophic State Index (IET) | Carlson IET | Lamparelli IET | Temporal Trend Analysis | Single parameter trend | Plotting trends | Multiple parameters | Parameter-specific Analysis | Summary statistics | Parameter plots | Statistical Methods | Theil-Sen estimator | Spearman correlation | Best Practices | Choosing parameters for IQA | Handling censored values | Trend analysis | Units consistency | References | Summary
Rendered fromtikatuwq-methods.Rmdusingknitr::rmarkdown

Last update: 2026-10-16
Started: 2025-11-16

Readme and manuals

Help Manual

Help pageTopics
Atribui periodo hidrologico (chuvoso / seco) a cada amostraassign_season
Avaliacao de balneabilidade — CONAMA 274/2000balnear_check
Classifica valores do IQA/WQI em faixas qualitativasclassify_iqa
Classifica TSI (Carlson) em faixas qualitativasclassify_tsi_carlson
Classifica TSI (Lamparelli) em faixas qualitativasclassify_tsi_lamparelli
Normalize/standardize unitsclean_units
Compara motores de calculo do IQA em amostras pareadascompare_iqa
Comparacao estatistica entre periodos hidrologicoscompare_seasons
Carga poluidora (concentracao x vazao)compute_load
CONAMA conformity check (detailed; default class = "2")conama_check
Conformidade CONAMA 357/2005 por frequenciaconama_freq_check
Limits for Brazilian CONAMA 357/2005conama_limits
CONAMA conformity report (table)conama_report
CONAMA conformity summary (long format)conama_summary
Text summary of conformity (bulleted, formatted)conama_text
Probabilidade de excedencia de um limiteexceedance_prob
Fix and validate geographic coordinates (lat/lon)fix_coords
Generate analytical paragraphs (rule-based)generate_analysis
Trophic State Index (Carlson)iet_carlson
Trophic State Index (Lamparelli)iet_lamparelli
Water Quality Index (WQI / IQA CETESB)iqa
Auditoria detalhada dos subindices do IQA (metodo CETESB)iqa_components
Metodos de calculo do IQA disponiveis no pacoteiqa_methods
Teste de Mann-Kendall sazonalmk_seasonal
Normaliza nomes de colunas de um df para os nomes canonicos do pacotenormalize_param_names
National Sanitation Foundation Water Quality Index (NSF WQI)nsfwqi
Plot temporal de um parametro (com filtro por rio e/ou ponto)param_plot
Plot temporal para varios parametros (filtro por rio/ponto)param_plot_multi
Resumo estatistico por parametro (com filtro por rio e/ou ponto)param_summary
Resumo para varios parametros (filtro por rio/ponto)param_summary_multi
Tendencia temporal por parametro (por rio/ponto se existentes)param_trend
Tendencia para varios parametros (filtro por rio/ponto)param_trend_multi
Boxplots by site/parameterplot_box
Heatmap of parameters vs. sitesplot_heatmap
Visualiza o Indice de Estado Trofico (IET / TSI)plot_iet
Plot IQA by site/dateplot_iqa
Plot interactive map of sampling points (default Leaflet pins)plot_map
Mapa interativo de qualidade da agua por ponto de amostragemplot_map_quality
Time series by parameterplot_series
Linha de tendencia temporal para parametros de qualidade da aguaplot_trend
Read water-quality CSV (robust parsing)read_wq
Render a water-quality report from the internal R Markdown templaterender_report
Descriptive summaries by groupresume_wq
Tendencia monotona por parametro e ponto (Theil-Sen + Spearman)trend_param
Validate presence of required columnsvalidate_wq
Example water quality dataset (subset of real data)wq_demo
Analise de Componentes Principais (PCA) de parametros de qualidade da aguawq_pca