# 通知設計書 4-progress_estimated() 非推奨

## 概要

本ドキュメントは、dplyrパッケージにおける`progress_estimated()`関数の非推奨警告通知について、その設計仕様を定義するものである。

### 本通知の処理概要

`progress_estimated()`関数はdplyr 1.0.0で非推奨となり、progressパッケージへの移行が推奨されている。この通知は、ユーザーが`progress_estimated()`を呼び出した際に、lifecycleパッケージの`deprecate_warn()`関数を通じて警告メッセージを表示する。

**業務上の目的・背景**：`progress_estimated()`は、処理の進捗状況と残り時間を表示するテキストプログレスバーを提供する関数であった。しかし、プログレスバーの提供はdplyrパッケージの責務範囲外であると判断され、より高機能なprogressパッケージへの移行が推奨された。dplyrはデータ操作に集中し、進捗表示は専門のパッケージに委ねる方針が採られた。

**通知の送信タイミング**：ユーザーがRコード内で`progress_estimated()`関数を呼び出した瞬間に、この警告が発生する。dplyr 1.2.0から`always = TRUE`が設定されており、毎回警告が表示される。

**通知の受信者**：Rコンソールまたはスクリプトを実行している開発者・データアナリスト。警告メッセージはRの標準警告システムを通じてコンソールに表示される。

**通知内容の概要**：関数が非推奨である旨と、非推奨となったバージョン（1.0.0）の情報が表示される。progressパッケージのGitHubリンクがドキュメントで参照されている。

**期待されるアクション**：ユーザーは`progress_estimated()`の使用をprogressパッケージ（https://github.com/r-lib/progress）に移行することが期待される。progressパッケージはより柔軟で高機能なプログレスバーを提供する。

## 通知種別

コンソール警告（lifecycle deprecation warning）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（関数呼び出し時即座に表示） |
| 優先度 | 中（警告レベル） |
| リトライ | 無し（`always = TRUE`のため毎回表示） |

### 送信先決定ロジック

警告メッセージはRの標準出力（stderr）に送信される。受信者の決定は不要であり、関数を呼び出したセッションに対して直接表示される。

## 通知テンプレート

### コンソール警告の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | lifecycle パッケージ |
| 形式 | テキスト |

### 本文テンプレート

```
`dplyr::progress_estimated()` was deprecated in dplyr 1.0.0.
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | コンソール警告のため添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| when | 非推奨となったバージョン | ハードコード "1.0.0" | Yes |
| what | 非推奨となった関数名 | ハードコード "dplyr::progress_estimated()" | Yes |
| always | 毎回警告を表示するか | ハードコード TRUE | Yes |
| id | 重複抑制用ID | ハードコード "dplyr-progress-estimated" | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 関数呼び出し | `progress_estimated()`の実行 | 常に | ユーザーがコード内で`progress_estimated()`を呼び出すたびに警告表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | `always = TRUE`のため、毎回警告が表示される（1.2.0以降） |
| lifecycle verbosityの設定 | `options(lifecycle_verbosity = "quiet")` で警告を完全に抑制可能 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[progress_estimated関数呼び出し] --> B[lifecycle::deprecate_warn実行]
    B --> C[警告メッセージ生成]
    C --> D[コンソールに警告表示]
    D --> E[Progress$new実行]
    E --> F[R6オブジェクト初期化]
    F --> G[Progressオブジェクト返却]
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | データベースアクセスは発生しない |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | データベース更新は発生しない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ティックオーバーフロー | `tick()`が総数nを超えて呼ばれた場合 | "No more ticks." エラー発生 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 該当なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（ユーザーの関数呼び出しに応じて即座に表示）

## セキュリティ考慮事項

- 個人情報の取り扱い：なし
- 警告メッセージには機密情報は含まれない
- 外部通信は発生しない

## 備考

- `progress_estimated()`はR6クラス`Progress`のインスタンスを返す
- Progressクラスは`tick()`, `print()`, `pause()`, `stop()`のメソッドを持つ
- プログレスバーの表示は`dplyr.show_progress`オプション（デフォルトTRUE）で制御可能
- 非インタラクティブセッションやknitr内では自動的に表示が抑制される
- `min_time`パラメータで最小経過時間を設定でき、短時間処理での表示を抑制可能
- dplyr 1.2.0から`always = TRUE`に変更され、より強い非推奨となった

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

R6クラス`Progress`の構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | progress.R | `R/progress.R` | `Progress` R6クラスの定義（56-162行目） |

**読解のコツ**: R6クラスは参照セマンティクスを持つオブジェクト指向プログラミングの仕組み。`public = list(...)`内にメソッドとフィールドが定義される。

#### Step 2: エントリーポイントを理解する

`progress_estimated()`関数のエントリーポイントを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | progress.R | `R/progress.R` | `progress_estimated()`関数の定義（44-54行目） |

**主要処理フロー**:
1. **45行目**: `always = TRUE`への変更コメント（1.2.0）
2. **46-51行目**: `lifecycle::deprecate_warn()`の呼び出し
3. **53行目**: `Progress$new(n, min_time = min_time)`でR6オブジェクト生成

#### Step 3: Progressクラスの機能を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | progress.R | `R/progress.R` | フィールド定義（59-65行目） |
| 3-2 | progress.R | `R/progress.R` | `initialize()`メソッド（67-71行目） |
| 3-3 | progress.R | `R/progress.R` | `tick()`メソッド（91-102行目） |
| 3-4 | progress.R | `R/progress.R` | `print()`メソッド（114-160行目） |

**主要フィールド**:
- `n`: 総アイテム数
- `i`: 現在のカウンター
- `init_time`: 開始時刻
- `min_time`: 最小表示待機時間

#### Step 4: 表示制御ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | progress.R | `R/progress.R` | `print()`内の表示条件（115-128行目） |

**表示抑制条件**:
- `dplyr.show_progress`がFALSEの場合
- 非インタラクティブセッションの場合
- knitr実行中の場合
- 最小時間未経過の場合

### プログラム呼び出し階層図

```
progress_estimated(n, min_time)
    │
    ├─ lifecycle::deprecate_warn()
    │      └─ 警告メッセージ表示
    │
    └─ Progress$new(n, min_time)
           │
           ├─ initialize()
           │      └─ begin()
           │
           ├─ tick() [ユーザー呼び出し]
           │      └─ i カウンター更新
           │
           ├─ print() [ユーザー呼び出し]
           │      ├─ 表示条件チェック
           │      ├─ 残り時間計算
           │      └─ プログレスバー出力
           │
           ├─ pause(x) [ユーザー呼び出し]
           │      └─ Sys.sleep(x)
           │
           └─ stop() [ユーザー呼び出し]
                  └─ 完了/中断処理
```

### データフロー図

```
[入力]               [処理]                    [出力]

n, min_time ─────▶ progress_estimated() ───▶ 警告メッセージ（stderr）
                         │
                         ▼
                  Progress$new() ──────────▶ Progressオブジェクト
                         │
                         ▼ [繰り返し]
                  tick() + print() ────────▶ プログレスバー（stdout）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| progress.R | `R/progress.R` | ソース | `progress_estimated()`と`Progress`クラスの定義 |
| compat-lifecycle.R | `R/compat-lifecycle.R` | ソース | lifecycleパッケージとの互換性 |
| NAMESPACE | `NAMESPACE` | 設定 | エクスポート定義 |
