Adding a progress bar by default in a package
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- r
調査の方向性
with_progress()について説明しているドキュメントのセクションから始め、パッケージが制御する進捗ハンドラーに関する issue の議論を確認してください。パッケージがデフォルトで with_progress() を呼び出すべきかどうかについて文書化された決定に達し、ユーザーに推奨される動作が明確になれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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?
- 主要言語
- R
- スター
- 299
- フォーク
- 11
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
futureverse/progressr のほかの issue
-
feature request
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
futureverse/progressr#199 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
futureverse/progressr#197 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
futureverse/progressr#195 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 28/100
futureverse/progressr#191 ·
-
question
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
futureverse/progressr#155 · コメント 5 件 ·
futureverse/progressr の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
HelenaLC/spatialdataR#284 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
mlr-org/mlr3cmprsk#42 ·
メンテナーはふだん 1 日以内に返信
-
Hackathon: Tier 1
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
pharmaverse/logrx#309 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100