From 3584c55940ab83eafd0300bae517cc50400aa6af Mon Sep 17 00:00:00 2001
From: Paola Corrales <paobcorrales@gmail.com>
Date: Tue, 26 Nov 2024 20:32:24 +1100
Subject: [PATCH] doc

---
 man/decil.Rd      | 19 +++++++++++++++----
 man/olas.Rd       |  6 +++++-
 man/pdsi.Rd       |  8 ++++++--
 man/spi_indice.Rd | 14 +++++++-------
 4 files changed, 33 insertions(+), 14 deletions(-)

diff --git a/man/decil.Rd b/man/decil.Rd
index 9c5bbd9..5d9aadb 100644
--- a/man/decil.Rd
+++ b/man/decil.Rd
@@ -28,9 +28,10 @@ a la distribución teórica. Puede ser:
 de la anomalía porcentual.}
 }
 \value{
-Devuelve un vector numérico con el decil asociado a cada valor de la variable.
-En este caso la columna \code{deciles} es de tipo doble ya que devuelve el valor exacto
-del decil sin redondeos. Para el cálculo de la anomalía porcentual también
+Para el cálculo de los deciles, devuelve un vector numérico con el decil
+asociado a cada valor de la variable. En este caso la columna \code{deciles} es de
+tipo doble ya que devuelve el valor exacto del decil sin redondeos.
+Para el cálculo de la anomalía porcentual también
 devuelve un vector numérico. Las funciones son compatibles con
 \code{\link[dplyr:group_by]{dplyr::group_by()}} y \code{\link[dplyr:mutate]{dplyr::mutate()}}.
 }
@@ -59,9 +60,19 @@ precip_mensual <- NH0358 \%>\%
 precip_mensual \%>\%
   mutate(deciles = decil(precip))
 
-# Definiendo un periodo de referencia
+# Deciles definiendo un periodo de referencia
 precip_mensual \%>\%
   mutate(deciles = decil(precip,
                          referencia = lubridate::year(fecha) <= 1958))
 
+# Anomalia porcentual usando como referencia la serie completa
+NH0358 \%>\%
+  mutate(anomalia = anomalia_porcentual(precip)) \%>\%
+  slice_head(n = 10)
+
+#  Anomalia porcentual definiendo un periodo de referencia
+precip_mensual \%>\%
+  mutate(deciles = anomalia_porcentual(precip,
+                         referencia = lubridate::year(fecha) <= 1958))
+
 }
diff --git a/man/olas.Rd b/man/olas.Rd
index 5ce1c1a..a4d246c 100644
--- a/man/olas.Rd
+++ b/man/olas.Rd
@@ -44,7 +44,11 @@ data(NH0358)
 
 library(dplyr)
 NH0358 \%>\%
-  reframe(olas(fecha, calor = t_max > 20, frio = t_min <= 0)) \%>\%
+  reframe(olas(fecha, calor = t_max > 20)) \%>\%
+  slice_head(n = 10)
+
+NH0358 \%>\%
+  reframe(olas(fecha, frio = t_min <= 0)) \%>\%
   slice_head(n = 10)
 
 }
diff --git a/man/pdsi.Rd b/man/pdsi.Rd
index cf123fa..f467f11 100644
--- a/man/pdsi.Rd
+++ b/man/pdsi.Rd
@@ -10,9 +10,9 @@ pdsi(precipitacion, etp, cc = 100, coeficientes = pdsi_coeficientes())
 pdsi_ac(precipitacion, etp, cc = 100, coeficientes = pdsi_coeficientes())
 }
 \arguments{
-\item{precipitacion}{serie de precipitación sin datos faltantes (en mm).}
+\item{precipitacion}{serie de precipitación sin datos faltantes (en mm). Ver sección Details.}
 
-\item{etp}{serie de evapotranspiración potencial sin datos faltantes.}
+\item{etp}{serie de evapotranspiración potencial sin datos faltantes. Ver sección Details.}
 
 \item{cc}{capacidad de campo (en mm).}
 
@@ -36,6 +36,10 @@ del índice usando la función \code{\link[=pdsi_coeficientes]{pdsi_coeficientes
 
 Alternativamente, Wells et al. (2004) propuso el Indice de Severidad de Sequía de Palmer Autocalibrado
 que tiene la capacidad de ajustar las constantes empíricas durante el cálculo del indice.
+
+Si bien el cálculo de este indice funcionará para series de datos cortas (datos
+diarios para un mes o datos mensuales para un año), es necesario contar con una
+climatología, es decir 30 años para que el resultado sea confiable.
 }
 \examples{
 
diff --git a/man/spi_indice.Rd b/man/spi_indice.Rd
index 66ce6f0..0bc23a2 100644
--- a/man/spi_indice.Rd
+++ b/man/spi_indice.Rd
@@ -52,17 +52,17 @@ Un data.frame con columnas
 }
 }
 \description{
-Calcula el Índice Estandarizado de Precipitación para distintas escalas. El
-\code{spi_indice} toma valores de precipitación mientras que el \code{spei_indice} toma
+Calcula el Índice Estandarizado de Precipitación para distintas escalas. Las
+funciones \code{spi_indice} y \code{spei_indice} usan internamente a la función \link[SPEI:Drought-indices]{SPEI::spi}
+pero tienen la ventaja de devolver el resultado como un data.frame que se
+puede usar de manera directa para el análisis de datos con dplyr.
+}
+\details{
+La función \code{spi_indice} toma valores de precipitación mientras que \code{spei_indice} toma
 valores del balance entre precipitación y evapotranspiración potencial.
 Internamente hacen lo mismo; la única diferencia es la distribución teórica
 usada por defecto para ajustar los datos.
 }
-\details{
-Estas funciones usan internamente a la función \link[SPEI:Drought-indices]{SPEI::spi} pero tienen la ventaja
-de devolver el resultado como un data.frame que se puede usar de manera directa
-para el análisis de datos con dplyr.
-}
 \examples{
 
 library(dplyr)