[feat]: get index error distribution from SS3 models

Abierto
  • ¿Algo no está bien?
#471 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
54/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
r
Área
data-visualization

Línea de trabajo

Read convert_output() and plot_index() to trace how $cpue becomes the plotted index intervals; the issue does not name source files or tests. Inspect how r4ss::SS_output() provides $survey_error and $survey_units, then decide how that information should be represented in the converted output. Done means index intervals reflect each SS3 error structure, including symmetric intervals for normal errors.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement
Is your feature request related to a problem? Please describe.

Thanks to @ericward-noaa for adding index intervals in https://github.com/nmfs-ost/stockplotr/pull/468/. This is an important feature that is important to be able to interpret the index fits.

One refinement needed in the future is to account for the fact that SS3 has multiple options for error structure for indices:

  • -1=normal;
  • 0=lognormal;
  • 1=lognormal with bias correction;
  • >1=df for T-distribution

Of these, lognormal probably covers at least 95% of models, but the normal error is used for models that include an environmental predictor of recruitment deviations.

The plot below was created loading stockplotr from Eric's fork associated with #468 and running the following code which relies on a petrale sole model with an index of recruitment deviations posted by @okenk. The "env" fleet uses normal error since the index spans zero so the intervals should be symmetric around the points and not tiny for observations close to zero.

petrale <- r4ss::SS_output('https://raw.githubusercontent.com/okenk/recruit_index_sims/refs/heads/main/simulations/petrale/0.2_30/30/em/')
petrale_converted <- convert_output(petrale)
plot_index(petrale_converted, interval = 0.95, module = "cpue")
Image
Describe the solution you would like.

I don't think that convert_output() is currently getting the information on error structure. In Report.sso that's in a separate table from the main table of index output.

Currently, r4ss::SS_output() returns the table $cpue (which is converted and serves the basis for the plots) as well as two vectors $survey_units (which is probably not needed for plotting), and $survey_error, which contains the codes above.

I'm happy to modify r4ss::SS_output() to merge those vectors into $cpue so that units and error were just additional columns. These would then need to be somehow integrated into the table created by convert_output(), ideally in a format that is similar to what FIMS will use to store index error structure assuming that in the future there will be additional uncertainty options beyond the current ~ dlnorm() option.

Describe alternatives you have considered

stockplotr::convert_output() could also do the merging of the separate SS3 tables

Additional context

No response

Lenguaje dominante
R
Estrellas
20
Forks
10
Merge medio
3 d 8 h
PR fusionados (30 d)
31

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de nmfs-ost/stockplotr

Todos los issues de nmfs-ost/stockplotr

Issues similares

Más issues de R

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.