# 通知設計書 7-all_equal() 非推奨

## 概要

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

### 本通知の処理概要

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

**業務上の目的・背景**：`all_equal()`関数は、2つのデータフレームを柔軟に比較する機能を提供していた。デフォルトで行と列の順序を無視する設計であったが、この暗黙的な動作が重要な違いを見逃しやすくするという問題があった。データフレームの比較において、行や列の順序の違いは多くの場合重要な情報であり、それを自動的に無視することはユーザーにとって予期しない動作につながる可能性があった。このため、より明示的な制御を必要とするbase Rの`all.equal()`への移行が推奨された。

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

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

**通知内容の概要**：関数が非推奨である旨、代替として`all.equal()`を使用すべき旨、行や列の順序を手動で調整する必要がある旨が表示される。

**期待されるアクション**：ユーザーは`all_equal()`の呼び出しを`all.equal()`に置き換え、必要に応じて行や列の順序を明示的に整列させることが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
`all_equal()` was deprecated in dplyr 1.1.0.
i Please use `all.equal()` instead.
i And manually order the rows/cols as needed
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| when | 非推奨となったバージョン | ハードコード "1.1.0" | Yes |
| what | 非推奨となった関数名 | ハードコード "all_equal()" | Yes |
| with | 代替関数名 | ハードコード "all.equal()" | Yes |
| details | 追加の説明 | ハードコード | Yes |
| always | 毎回警告を表示するか | ハードコード TRUE | Yes |
| id | 重複抑制用ID | ハードコード "dplyr-all-equal" | Yes |

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[all_equal関数呼び出し] --> B[lifecycle::deprecate_warn実行]
    B --> C[警告メッセージ生成]
    C --> D[コンソールに警告表示]
    D --> E[equal_data_frame実行]
    E --> F{データフレーム互換?}
    F -->|No| G[差異メッセージ返却]
    F -->|Yes| H[行比較]
    H --> I{行数一致?}
    I -->|No| J[行数差異メッセージ返却]
    I -->|Yes| K[データ比較]
    K --> L{完全一致?}
    L -->|Yes| M[TRUE返却]
    L -->|No| N[差異メッセージ返却]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 型不一致 | 比較対象がデータフレームでない場合 | 適切なエラーメッセージ表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- `all_equal()`は`ignore_col_order`（デフォルトTRUE）と`ignore_row_order`（デフォルトTRUE）のオプションを持つ
- `convert`オプションで類似クラスの変換（factor→character、integer→double）が可能
- 戻り値はTRUE（等しい場合）または差異を説明する文字列ベクトル
- 内部的には`equal_data_frame()`関数を使用して比較を実行
- この関数は`@keywords internal`としてマークされており、主に内部使用やテストを想定
- `always = TRUE`が設定されているため、この警告は非常に強い非推奨を示している

---

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

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

### 推奨読解順序

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

`all_equal()`の引数構造と戻り値を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | all-equal.R | `R/all-equal.R` | 関数シグネチャと引数（34-41行目） |

**読解のコツ**: `ignore_col_order`, `ignore_row_order`, `convert`の3つのオプションが比較動作を制御する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | all-equal.R | `R/all-equal.R` | `all_equal()`関数の定義（34-58行目） |

**主要処理フロー**:
1. **42-49行目**: `lifecycle::deprecate_warn()`の呼び出し（詳細メッセージ付き）
2. **51-57行目**: `equal_data_frame()`呼び出し

#### Step 3: 警告メッセージの詳細を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | all-equal.R | `R/all-equal.R` | `details`引数（46行目） |

**メッセージ構成**:
- 代替関数`all.equal()`の推奨
- 行/列の手動整列の必要性

#### Step 4: 比較ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | all-equal.R | `R/all-equal.R` | `equal_data_frame()`関数（60-137行目） |
| 4-2 | all-equal.R | `R/all-equal.R` | `is_compatible()`呼び出し（67-72行目） |

**比較手順**:
1. 列の互換性チェック
2. 行数チェック
3. キーベースの行比較
4. 行順序チェック（`ignore_row_order`がFALSEの場合）

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

```
all_equal(target, current, ignore_col_order, ignore_row_order, convert)
    │
    ├─ lifecycle::deprecate_warn()
    │      └─ 警告メッセージ表示（details付き）
    │
    └─ equal_data_frame()
           │
           ├─ is_compatible(x, y, ignore_col_order, convert)
           │      └─ 列の互換性チェック
           │
           ├─ 行数チェック
           │
           ├─ as_tibble() [両データフレーム]
           │
           ├─ dplyr_locate_sorted_groups()
           │      └─ キーベースのグループ分け
           │
           ├─ vec_in() [キー存在チェック]
           │
           └─ vec_equal() [行順序チェック]
```

### データフロー図

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

target, ────────▶ all_equal()呼び出し ─────▶ 警告メッセージ（stderr）
current                │
                       ▼
               equal_data_frame() ─────────▶ TRUE または 差異文字列
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| all-equal.R | `R/all-equal.R` | ソース | `all_equal()`と`equal_data_frame()`の定義 |
| compat.R | `R/compat.R` | ソース | `is_compatible()`関数 |
| compat-lifecycle.R | `R/compat-lifecycle.R` | ソース | lifecycleパッケージとの互換性 |
| NAMESPACE | `NAMESPACE` | 設定 | エクスポート定義 |
