Revisar Documentacion archivo 'build_stan_data.R'

[willandru]

1. Corrección en la función sf_cauchy()

Problema:

• El mensaje de error menciona "Normal distribution" en lugar de "Cauchy distribution", y tiene el sibolo '=>' en lugar de '>='.

Código actual:
stop( "Normal distribution only accepts", " location>=0andscale=>0 for mean and standard deviation") }

Correción sugerida:

stop( "Cauchy distribution only accepts", " location>=0andscale>=0 for mean and standard deviation"" )

2. Falta de documentación en sf_none()

Problema:

• La función sf_none() no tiene documentación en roxygen2 (@return, @examples, y @export están ausentes).

3. Posible falta de documentación en build_stan_data()

Problema

• En la documentación de @param, faltan las descripciones de algunos parámetros clave: foi_index foi_sigma_rw seroreversion_prior
  Correción sugerida:
  #' Builds stan data for sampling depending on the selected model #' #' @inheritParams fit_seromodel #' @param foi_index Index structure for force-of-infection modeling #' @param foi_sigma_rw Prior specification for the standard deviation in FOI #' @param seroreversion_prior Prior for seroreversion rate (None, Uniform, Normal) #' @return List with necessary data for sampling the specified model #' @export

4. Revisión general de @param en todas las funciones

Problema

• Algunas funciones podrían no describir correctamente todos sus parámetros en @param. Se recomienda hacer una revisión exhaustiva para garantizar que

5. Validación final con devtools::document() y devtools::check()

Problema
-Después de hacer estas correcciones, es necesario regenerar la documentación y verificar que no haya errores.
Correción sugerida:
devtools::document() devtools::check()

[ntorresd]

Gracias @willandru! El mensaje de error de sf_cauchy() va a quedar:

    stop(
      "Cauchy distribution only accepts",
      " `location>=0` and `scale>=0` for median and median absolute deviation")

"median" y "median absolute deviation" corresponden a los nombres correctos de los parámetros de posición y escala de esta distribución.

En cuanto a la documentación de las otras funciones, nota que varias de ellas tienen el tag @inheritParams some_function, que le asigna las descripciones de los parámetros coincidentes con aquellos de some_function. Si revisas en los Rd files vas a encontrar las documentaciones completas a pesar de que en el código no aparecen de manera explícita.