# 通知設計書 20-group_nest/group_split dots無視

## 概要

本ドキュメントは、dplyrパッケージの`group_nest()`および`group_split()`関数において、既にグループ化されたデータフレーム（`grouped_df`）に対して`...`引数が指定された場合に、その引数が無視されることを通知する警告メッセージの設計を記載する。

### 本通知の処理概要

`group_nest()`と`group_split()`は、グループ化されたデータフレームを処理する関数である。未グループ化のデータフレームに対して使用する場合、`...`引数でグループ化変数を指定できる。しかし、既にグループ化されている`grouped_df`に対しては、既存のグループ構造が使用され、`...`引数は無視される。

**業務上の目的・背景**：`grouped_df`に対して`...`引数を指定することは意図しない動作を示唆する。ユーザーは既存のグループ構造に追加のグループ変数を追加しようとしている可能性があるが、この関数ではそれができない。代わりに`group_by(..., .add = TRUE)`を使用してからこれらの関数を呼び出す必要があることを案内する。

**通知の送信タイミング**：`group_nest.grouped_df()`または`group_split.grouped_df()`メソッド内で、`...`引数が存在する（`dots_n(...) > 0`）場合に警告が発生する。

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

**通知内容の概要**：「Calling `group_nest()` on a `grouped_df` ignores `...`. Please use `group_by(..., .add = TRUE) |> group_nest()`.」という形式のcli警告が表示される。

**期待されるアクション**：ユーザーは`...`引数を削除するか、`group_by(..., .add = TRUE)`を先に呼び出してからこれらの関数を使用する。

## 通知種別

コンソール警告メッセージ（`cli::cli_warn()`による`warning`条件）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 形式 | cli警告メッセージ |

### 本文テンプレート（group_nestの場合）

```
Calling `group_nest()` on a `grouped_df` ignores `...`. Please use `group_by(..., .add = TRUE) |> group_nest()`.
```

### 本文テンプレート（group_splitの場合）

```
Calling `group_split()` on a `grouped_df` ignores `...`. Please use `group_by(..., .add = TRUE) |> group_split()`.
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| fn | 関数名（group_nest/group_split） | 呼び出し元から | Yes |
| class | クラス名（grouped_df/rowwise_df） | 入力データから | Yes |
| with | 代替の使用方法 | 固定文字列 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 関数呼び出し | `group_nest()`の実行（grouped_dfに対して） | `...`引数が存在する | `dots_n(...) > 0`がTRUE |
| 関数呼び出し | `group_split()`の実行（grouped_dfに対して） | `...`引数が存在する | `dots_n(...) > 0`がTRUE |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `...`引数が指定されていない場合 | 無視する引数がないため |
| `suppressWarnings()`でラップされている場合 | ユーザーが明示的に警告を抑制 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[group_nest/group_split実行 on grouped_df] --> B{...引数があるか}
    B -->|Yes| C[warn_ignores_dots呼び出し]
    C --> D[cli::cli_warn発行]
    D --> E[グループ構造を使用して処理]
    B -->|No| E
    E --> F[結果を返す]
```

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

### 参照テーブル一覧

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

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

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

該当なし

## 配信設定

### レート制限

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

### 配信時間帯

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

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

特になし。

## 備考

- この警告は非推奨警告ではなく、使用方法に関するアドバイス
- `warn_ignores_dots()`ヘルパー関数で共通化されている
- `group_split.rowwise_df()`でも同様の警告が発生する

---

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

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

### 推奨読解順序

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

`grouped_df`は既にグループ化情報を持っているため、追加の`...`引数は無視される。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | group-nest.R | `R/group-nest.R` | 5-33行目のドキュメントでgroup_nest()の使用法を理解 |
| 1-2 | group-split.R | `R/group-split.R` | 1-36行目のドキュメントでgroup_split()の使用法を理解 |

**読解のコツ**: ungrouped dfとgrouped dfでの動作の違いを理解することが重要。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | group-nest.R | `R/group-nest.R` | 69-78行目の`group_nest.grouped_df()`メソッド |
| 2-2 | group-split.R | `R/group-split.R` | 96-118行目の`group_split.grouped_df()`メソッド |

**主要処理フロー（group_nest.grouped_dfの場合）**:
1. **70-76行目**: `dots_n(...)` > 0 の場合、`warn_ignores_dots()`を呼び出し
2. **77行目**: `group_nest_impl()`で処理

**主要処理フロー（group_split.grouped_dfの場合）**:
1. **109-115行目**: `dots_n(...)` > 0 の場合、`warn_ignores_dots()`を呼び出し
2. **117行目**: `group_split_impl()`で処理

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | group-nest.R | `R/group-nest.R` | 81-85行目の`warn_ignores_dots()`ヘルパー関数 |

**主要処理フロー**:
- **82-84行目**: `cli::cli_warn()`でcli形式の警告を発行
- **83行目**: 関数名、クラス名、代替方法を組み込んだメッセージ

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

```
group_nest(.tbl, ...) [on grouped_df]
    │
    ├─ lifecycle::signal_stage()        # experimental通知
    │
    ├─ [dots_n(...) > 0 の場合]
    │      │
    │      └─ warn_ignores_dots()        # 通知(本通知)
    │             │
    │             └─ cli::cli_warn()
    │
    └─ group_nest_impl(.tbl, .key, keep)
           │
           ├─ group_keys()
           │
           └─ group_split()

group_split(.tbl, ...) [on grouped_df]
    │
    ├─ lifecycle::signal_stage()        # experimental通知
    │
    ├─ [dots_n(...) > 0 の場合]
    │      │
    │      └─ warn_ignores_dots()        # 通知(本通知)
    │             │
    │             └─ cli::cli_warn()
    │
    └─ group_split_impl(.tbl, .keep)
```

### データフロー図

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

.tbl (grouped_df) ───┐
                     │
... (引数) ──────────┼──▶ group_nest.grouped_df() ──▶ tibble(keys + nested data)
                     │           │
.key (引数) ─────────┤           │
                     │           ├─▶ dots_n(...) > 0 チェック
keep (引数) ─────────┘           │        │
                                 │        ▼
                                 │   warn_ignores_dots()
                                 │        │
                                 │        ▼
                                 │   [コンソール警告]
                                 │   "Calling `group_nest()` on a `grouped_df` ignores `...`..."
                                 │
                                 └─▶ group_nest_impl()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| group-nest.R | `R/group-nest.R` | ソース | group_nest()関数とwarn_ignores_dots()の実装 |
| group-split.R | `R/group-split.R` | ソース | group_split()関数の実装 |
