Adding a progress bar by default in a package
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 20/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- r
- Área
- developer-experience
Línea de trabajo
Empieza por la sección de la documentación que describe with_progress() y revisa la discusión del issue sobre los manejadores de progreso controlados por los paquetes. Se considera terminado cuando haya una decisión documentada sobre si los paquetes deben invocar with_progress() de forma predeterminada y se haya aclarado el comportamiento recomendado para los usuarios.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Hi,
I'm slightly confused by this part of the documentation about with_progress():
IMPORTANT: This function is meant for end users only. It should not be used by R packages, which only task is to signal progress updates, not to decide if, when, and how progress should be reported.
I don't know whether it's because I don't fully understand everything about progressr or if it's a design choice where we may disagree.
Here is my use case:
I have a function that may take some time to run (couple dozens of minutes in most cases) and I would like to signal progress by default to users. Previously we were using the pbmcapply package but we moved away from it to get the flexibility from future (especially parallel processing on windows machines). In order to achieve this, we wrapped our future_lapply() loop with with_progress() in the function provided by our package.
Now my understanding is that if users don't like the progress bar, they can disable it by using handlers("void"). We even added a note in the function documentation to inform them of this option. (This is also a nice improvement compared to the previous pbmcapply solution.)
My issue with the approach you describe for progressr (the user should be in charge of using with_progress()) is that most users won't look into the docs and probably never bother adding the progress bar, even though they may enjoy it if they knew.
TL;DR: does it make sense to use with_progress() in a package to choose sensible defaults for the user?
- Lenguaje dominante
- R
- Estrellas
- 299
- Forks
- 11
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de futureverse/progressr
-
feature request
Dificultad 4/5 3-5 días Aptitud para principiantes 30/100
futureverse/progressr#199 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
futureverse/progressr#197 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
futureverse/progressr#195 ·
-
question
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
futureverse/progressr#155 · 5 comentarios ·
-
Custom progress handler enhancement help wanted
Dificultad 5/5 Más de una semana Aptitud para principiantes 22/100
futureverse/progressr#143 · 6 comentarios · 1 reacción ·
Todos los issues de futureverse/progressr
Issues similares
-
gdsa opencode: keep-alive cleanup trap fails with 'keepalive_pid: unbound variable'Posiblemente ocupada @darribas la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
sportsdataverse/sportyR#76 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
joshwlivingston/shinyfilters#155 ·
Los mantenedores suelen responder en 1 día
-
check_models ncv explanationAbiertoConsistency :green_apple: :apple: Docs :books:
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
easystats/performance#987 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 71/100