# 通知設計書 12-select時のグループ変数追加

## 概要

本ドキュメントは、dplyrパッケージの`select()`関数において、グループ化されたデータフレームから選択を行う際に、選択対象に含まれていないグループ変数が自動的に追加される場合に表示される情報通知の設計を記載する。

### 本通知の処理概要

`select()`関数は、データフレームから特定の列を選択する機能を提供する。グループ化されたデータフレーム（`grouped_df`）に対して`select()`を実行する場合、グループ構造を維持するためにグループ変数は常に保持される必要がある。

**業務上の目的・背景**：グループ化されたデータフレームにおいて、ユーザーがグループ変数を選択対象に含めなかった場合でも、dplyrはグループ構造の整合性を維持するために自動的にグループ変数を追加する。この通知により、ユーザーに予期しない列の追加を明示的に伝え、データ構造の変化を理解させる。これにより、後続の処理で予期しないエラーを防ぐ。

**通知の送信タイミング**：`select()`関数の実行時、`ensure_group_vars()`ヘルパー関数内で、選択対象にグループ変数が含まれていないことが検出された時点で通知が発生する。具体的には、`missing <- setdiff(group_loc, loc)`で欠落しているグループ変数を検出し、その結果が空でなく、かつ新しい変数名と衝突しない場合に通知される。

**通知の受信者**：R言語のコンソールを使用している開発者・データアナリスト。通知はコンソールに直接出力される。

**通知内容の概要**：「Adding missing grouping variables: `変数名1`, `変数名2`, ...」という形式で、自動追加されるグループ変数名が表示される。

**期待されるアクション**：ユーザーは通知を確認し、グループ変数が自動追加されることを理解する。必要に応じて、明示的にグループ変数を選択に含めるか、`ungroup()`してからselectを実行することを検討する。

## 通知種別

コンソール情報メッセージ（`inform()`による`message`条件）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（関数実行中に即座に表示） |
| 優先度 | 低（情報通知） |
| リトライ | 無し |

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

R言語の標準メッセージハンドラを通じてコンソールに出力される。`suppressMessages()`で抑制可能。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 形式 | テキスト |

### 本文テンプレート

```
Adding missing grouping variables: `{変数名1}`, `{変数名2}`, ...
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| added_group_loc | 追加されるグループ変数名のベクトル | `names(data)[missing]` から取得し、既存の選択と衝突しないものをフィルタ | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 関数呼び出し | `select()`の実行（grouped_dfに対して） | 選択対象にグループ変数が含まれていない | グループ変数の位置と選択位置の差分を検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| すべてのグループ変数が選択対象に含まれている場合 | 追加すべき変数がないため通知不要 |
| `suppressMessages()`でラップされている場合 | ユーザーが明示的にメッセージを抑制 |
| `notify = FALSE`で呼び出された場合 | 内部的な呼び出しでは通知を抑制 |
| 追加変数名が新しい変数名と衝突する場合 | #5841の修正により、衝突する変数は追加されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[select実行] --> B[tidyselect::eval_selectで選択位置取得]
    B --> C[ensure_group_vars呼び出し]
    C --> D{グループ変数が選択に含まれるか}
    D -->|No| E[missing変数を特定]
    E --> F{名前衝突があるか}
    F -->|No| G[inform関数で通知]
    F -->|Yes| H[衝突する変数は追加しない]
    G --> I[グループ変数を選択の先頭に追加]
    H --> I
    D -->|Yes| J[そのまま継続]
    I --> K[結果を返す]
    J --> K
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| 該当なし | - | インメモリデータフレーム操作 |

### テーブル別参照項目詳細

該当なし（データベースは使用しない）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | - | この通知自体はエラーではなく情報提供 |

### リトライ仕様

該当なし

## 配信設定

### レート制限

該当なし（即座に1回表示）

### 配信時間帯

該当なし（関数実行時に即座に表示）

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

変数名情報がコンソールに出力されるため、機密性の高い変数名が含まれる場合は注意が必要。

## 備考

- グループ変数は結果の先頭に追加される（`loc <- c(added_group_loc, loc)`）
- Issue #5841の修正により、新しい変数名と同名のグループ変数は追加されない
- この動作は`select()`固有であり、他のdplyr verbでは異なる挙動を示す場合がある

---

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

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

### 推奨読解順序

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

select()はグループ化されたデータフレーム（grouped_df）の構造を維持する必要がある。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | select.R | `R/select.R` | 1-51行目のドキュメントでselect()の概要を理解 |
| 1-2 | grouped-df.R | `R/grouped-df.R` | grouped_dfクラスの構造を理解 |

**読解のコツ**: グループ変数はデータフレームの属性として保持されており、select後も維持される必要がある。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | select.R | `R/select.R` | 53-55行目の`select()`ジェネリック関数 |
| 2-2 | select.R | `R/select.R` | 62-76行目の`select.data.frame()`メソッド |

**主要処理フロー**:
1. **65-69行目**: `tidyselect::eval_select()`で選択位置を取得
2. **70行目**: `ensure_group_vars(loc, .data, notify = TRUE)`でグループ変数を保証
3. **72-75行目**: 列の選択と名前の設定

#### Step 3: 通知ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | select.R | `R/select.R` | 80-102行目の`ensure_group_vars()`ヘルパー関数 |

**主要処理フロー**:
- **81行目**: `group_loc <- match(group_vars(data), names(data))`でグループ変数の位置を取得
- **82行目**: `missing <- setdiff(group_loc, loc)`で欠落しているグループ変数を検出
- **84-96行目**: 欠落がある場合の処理
- **85-86行目**: 追加するグループ変数の位置と名前を取得
- **89行目**: 名前衝突のチェック（#5841対応）
- **91-96行目**: 衝突しない変数があればinform()で通知

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

```
select(.data, ...)
    │
    ├─ select.data.frame()
    │      │
    │      ├─ tidyselect::eval_select()     # 選択位置の評価
    │      │
    │      ├─ ensure_group_vars()            # グループ変数の保証
    │      │      │
    │      │      ├─ group_vars()            # グループ変数名の取得
    │      │      │
    │      │      └─ inform()                # 通知(本通知)
    │      │             └─ glue()
    │      │             └─ paste0()
    │      │
    │      └─ dplyr_col_select()            # 列の選択
```

### データフロー図

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

.data (grouped_df) ───┐
                      │
... (選択式) ─────────┼──▶ select.data.frame() ──▶ 結果(grouped_df)
                      │           │
                      │           ├─▶ eval_select()
                      │           │
                      │           └─▶ ensure_group_vars()
                      │                    │
                      │                    ▼
                                [コンソール通知]
                    "Adding missing grouping variables: `var1`, `var2`"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| select.R | `R/select.R` | ソース | select()関数と関連ヘルパーの実装 |
| grouped-df.R | `R/grouped-df.R` | ソース | grouped_dfクラスの定義 |
| group-data.R | `R/group-data.R` | ソース | group_vars()等のグループ関連関数 |
