tikatuwq

tikatuwq-package

Utilities to import, clean, validate and analyze freshwater quality data.
Includes indices (IQA/WQI, TSI/IET Carlson and Lamparelli), compliance
checks against CONAMA 357/2005, visualizations, and rule-based analytical text.

internal

Tools to import, clean, validate, and analyze freshwater quality data in Brazil. Implements water quality indices including the Water Quality Index (WQI/IQA), the Trophic State Index (TSI/IET) after Carlson (1977) <doi:10.4319/lo.1977.22.2.0361> and Lamparelli (2004) <https://www.teses.usp.br/teses/disponiveis/41/41134/tde-20032006-075813/publico/TeseLamparelli2004.pdf>, and the National Sanitation Foundation Water Quality Index (NSF WQI) <doi:10.1007/s11157-023-09650-7>. 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> and generates reproducible reports for routine monitoring workflows.
The example dataset (`wq_demo`) is now a real subset from monitoring data (BURANHEM river, 2020-2024, 4 points, 20 rows, 14 columns including extra `rio`, `lat`, `lon`). All core examples and vignettes use this realistic sample, improving reproducibility and documentation value for users.

Vinicius Saraiva Santos

Water Quality Assessment and Environmental Compliance in Brazil

tikatuwq-package function

<ul>
<li>Indices: IQA/WQI; TSI/IET (Carlson, Lamparelli); NSF WQI prototype.</li>
<li>Compliance: CONAMA 357/2005 limits and per-record status.</li>
<li>Visualization: time series, boxplots, heatmap, IQA bars.</li>
<li>Reporting: simple Rmd/Quarto report; analytical paragraphs (rule-based).</li>
</ul>

Main features

<pre><code>
# demo data
data(wq_demo)</code></pre># compute IQA
d1 &lt;- iqa(wq_demo, na_rm = TRUE)# check compliance (CONAMA class "2")
d2 &lt;- conama_check(d1, classe = "2")# summary table (only violations)
conama_report(d2, classe = "2", only_violations = TRUE)

Quick start

See the package website for walkthroughs and examples:
<a href="https://tikatuwq.github.io/tikatuwq/">tikatuwq website</a>.

Vignettes

Maintainer: Vinicius Saraiva Santos <a href="/link/vinisaraiva%40gmail.com?package=tikatuwq&version=0.8.2" data-mini-rdoc="tikatuwq::vinisaraiva@gmail.com">vinisaraiva@gmail.com</a> (<a href="https://orcid.org/0009-0007-1387-7927">ORCID</a>)

Author

tikatuwq: Water quality tools for the Brazilian context — tikatuwq-package

<ul>
<li>Indices: IQA/WQI; TSI/IET (Carlson, Lamparelli); NSF WQI prototype.</li>
<li>Compliance: CONAMA 357/2005 limits and per-record status.</li>
<li>Visualization: time series, boxplots, heatmap, IQA bars.</li>
<li>Reporting: simple Rmd/Quarto report; analytical paragraphs (rule-based).</li>
</ul>

<pre><code>
# demo data
data(wq_demo)

# compute IQA
d1 &lt;- iqa(wq_demo, na_rm = TRUE)

# check compliance (CONAMA class "2")
d2 &lt;- conama_check(d1, classe = "2")

# summary table (only violations)
conama_report(d2, classe = "2", only_violations = TRUE)
</code></pre>

See the package website for walkthroughs and examples:
<a href='https://tikatuwq.github.io/tikatuwq/'>tikatuwq website</a>.

Maintainer: Vinicius Saraiva Santos <a href='mailto:vinisaraiva@gmail.com'>vinisaraiva@gmail.com</a> (<a href='https://orcid.org/0009-0007-1387-7927'>ORCID</a>)

tikatuwq-package: tikatuwq: Water quality tools for the Brazilian context

Description

Arguments

Main features

Quick start

Vignettes

Author

References

See Also