Package: tikatuwq 0.9.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, 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]

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

# Install 'tikatuwq' in R:
install.packages('tikatuwq', repos = c('https://cran.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:

4.16 score 12 scripts 152 downloads 42 exports 43 dependencies

Last updated from:b663eef4ce. Checks:4 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK140
source / vignettesOK227
linux-release-x86_64OK161
wasm-releaseOK136

Exports:assign_seasonbalnear_checkclassify_iqaclassify_tsi_carlsonclassify_tsi_lamparelliclean_unitscompare_seasonscompute_loadconama_checkconama_freq_checkconama_limitsconama_reportconama_summaryconama_textexceedance_probfix_coordsgenerate_analysisiet_carlsoniet_lamparelliiqamk_seasonalnsfwqiparam_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

tikatuwq authors

Rendered fromtikatuwq.Rmdusingknitr::rmarkdownon Jun 10 2026.

Last update: 2025-10-22
Started: 2025-09-22

tikatuwq: From raw water quality data to CONAMA report

tikatuwq developers

Rendered fromtikatuwq-workflow.Rmdusingknitr::rmarkdownon Jun 10 2026.

Last update: 2025-11-17
Started: 2025-11-17

tikatuwq: Water Quality Indices and Temporal Trends

tikatuwq developers

Rendered fromtikatuwq-methods.Rmdusingknitr::rmarkdownon Jun 10 2026.

Last update: 2025-11-17
Started: 2025-11-17

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
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)iqa
Teste de Mann-Kendall sazonalmk_seasonal
NSF 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