# 機能設計書 42-pick

## 概要

本ドキュメントは、dplyrパッケージの`pick()`関数の機能設計について記述する。`pick()`は`mutate()`や`summarise()`などのデータマスキング関数内で、tidyselect構文を使用して列のサブセットを選択し、データフレームとして返す関数である。

### 本機能の処理概要

`pick()`は、データマスキング関数（`mutate()`、`summarise()`など）の内部で使用され、選択した列をデータフレーム（tibble）として返す。`across()`が各列に関数を適用するのに対し、`pick()`は変換を行わずに列を選択するだけである。これにより、データフレームを入力として受け取る関数との連携が容易になる。

**業務上の目的・背景**：データ分析では、複数の列をまとめて処理する関数（例：`dense_rank()`でのジョイントランキング）に渡す必要がある場面がある。従来は列を個別に指定するか、複雑なワークアラウンドが必要だったが、`pick()`を使用することでtidyselect構文による柔軟な列選択と、データフレームを期待する関数への受け渡しが容易になる。また、`group_by()`などのtidy-select関数とdata-masking関数の間のブリッジパターンとしても活用できる。

**機能の利用シーン**：
- 複数列を使用したジョイントランキングの計算
- データフレームを入力として受け取る関数への列の受け渡し
- `group_by()`のtidy-selectラッパー関数の作成
- `count()`で動的に列を選択する場合

**主要な処理内容**：
1. tidyselect構文で列を選択する
2. 選択した列を現在のグループのデータから抽出する
3. tibbleとして結果を返す

**関連システム・外部連携**：特になし。dplyr内部で完結する関数である。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 該当なし | - | 本プロジェクトはRライブラリであり、ユーザーインターフェース画面は存在しない |

## 機能種別

データ変換 / 列選択

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ... | tidy-select | Yes | 選択する列を指定するtidyselect式 | 最低1つの列を選択すること |

### 入力データソース

データマスク内のデータフレーム（`mutate()`、`summarise()`などのdplyr動詞内で評価される）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| result | tibble | 選択した列を含むtibble。現在のグループのデータが含まれる |

### 出力先

呼び出し元のdplyr動詞に返される。

## 処理フロー

### 処理シーケンス

```
1. 入力パラメータの検証
   └─ ...が空の場合はエラーを発生させる
2. データマスクから現在のグループのデータを取得
   └─ mask$current_non_group_vars()で非グループ列を取得
   └─ mask$current_cols()で現在の列データを取得
3. tidyselect::eval_select()で列を選択
   └─ quosureの環境をデータマスクトップに設定
4. 選択した列でtibbleを作成
   └─ dplyr_pick_tibble()でtibbleを構築
5. tibbleを返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始: pick呼び出し] --> B{引数...が空か?}
    B -->|Yes| C[エラー: Must supply at least one input]
    B -->|No| D[データマスクを取得]
    D --> E[非グループ列のリストを取得]
    E --> F[tidyselect::eval_select で列を選択]
    F --> G[選択した列でデータを抽出]
    G --> H[dplyr_pick_tibble でtibbleを作成]
    H --> I[tibbleを返す]
    C --> J[終了]
    I --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-42-01 | グループ列の除外 | グループ化変数は選択できない（自動的にdplyr動詞で処理される） | grouped_dfに対して使用する場合 |
| BR-42-02 | 空選択の禁止 | 少なくとも1つの列を選択する必要がある | 常に適用 |
| BR-42-03 | 列名の重複禁止 | 列名の変更（リネーム）は許可されない | 常に適用 |
| BR-42-04 | 空選択時のtibble | 空選択時は1行0列のtibbleを返す | 理論上の動作（エラーで到達しない） |

### 計算ロジック

`pick()`は変換を行わないため、選択した列のデータをそのまま返す。

```
result = tibble(col1 = data$col1, col2 = data$col2, ...)
```

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | 本関数はインメモリ操作のみでデータベース操作を行わない |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 引数エラー | ...が空の場合 | 最低1つの列を指定する |
| - | 選択エラー | 存在しない列を指定した場合 | 存在する列名を指定する |
| - | コンテキストエラー | dplyr動詞の外で呼び出した場合 | mutate()やsummarise()内で使用する |

### リトライ仕様

リトライは不要（即座にエラーを返す）

## トランザクション仕様

該当なし（インメモリ操作のみ）

## パフォーマンス要件

- tibbleの作成は効率的に行われること
- 列のリサイクルに対応すること（`reframe()`内での使用を考慮）

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

特になし

## 備考

- `pick()`は`across(.fns = NULL)`の代替として設計された
- `across()`は各列に関数を適用するのに対し、`pick()`は列選択のみを行う
- ブリッジパターン（data-masking関数とtidy-select関数の間）での使用が推奨される

---

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

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

### 推奨読解順序

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

`pick()`はtibbleを返すシンプルな関数であるが、データマスクとの連携が重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | pick.R | `R/pick.R` | `pick()`関数の全体構造を理解する |

**読解のコツ**: `pick()`は評価時と展開時の2つのパスがある。評価パスは直接呼び出された場合、展開パスは`mutate()`内で展開される場合に使用される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | pick.R | `R/pick.R` | 71-106行目の`pick()`関数定義 |

**主要処理フロー**:
1. **77行目**: `peek_mask()` - データマスクを取得
2. **79-81行目**: `dots_n(...) == 0L`のチェック - 空入力エラー
3. **87-88行目**: 非グループ列のデータを取得
4. **92-94行目**: quosureを作成し環境を設定
5. **96-100行目**: `tidyselect::eval_select()`で列を選択
6. **102-105行目**: `dplyr_pick_tibble()`でtibbleを作成

#### Step 3: 展開処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | pick.R | `R/pick.R` | 110-166行目の`expand_pick()`と関連関数 |

**主要処理フロー**:
- **110-117行目**: `expand_pick()` - pick呼び出しの展開
- **119-134行目**: `expand_pick_quo()` - quosureの展開処理
- **136-166行目**: `expand_pick_call()` - call式の展開処理

#### Step 4: tibble作成処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | pick.R | `R/pick.R` | 208-222行目の`dplyr_pick_tibble()`関数 |

**読解のコツ**: `dplyr_pick_tibble()`は選択した列間のリサイクルを処理し、`reframe()`内での使用を可能にする。空選択時は1行0列のtibbleを返す。

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

```
pick(...)
    │
    ├─ peek_mask() [データマスク取得]
    │
    ├─ stop_pick_empty() [空入力時エラー]
    │
    ├─ mask$current_non_group_vars()
    │
    ├─ mask$current_cols()
    │
    ├─ enquos(...) [quosure作成]
    │
    ├─ tidyselect::eval_select()
    │      └─ 列選択の評価
    │
    └─ dplyr_pick_tibble()
           ├─ vec_size_common()
           ├─ vec_recycle_common()
           └─ dplyr_new_tibble()
```

### データフロー図

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

データマスク内     ───▶  peek_mask()でマスク取得    ───▶  マスクオブジェクト
  data.frame

...引数            ───▶  enquos()でquosure化        ───▶  quosureリスト

quosureリスト      ───▶  tidyselect::eval_select()  ───▶  列インデックス

列インデックス     ───▶  dplyr_pick_tibble()        ───▶  tibble
  + データ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| pick.R | `R/pick.R` | ソース | `pick()`関数の実装 |
| across.R | `R/across.R` | ソース | `across()`関数（`pick()`と対になる関数） |
| data-mask.R | `R/data-mask.R` | ソース | データマスク関連のユーティリティ |
| mutate.R | `R/mutate.R` | ソース | `pick()`が使用される主要コンテキスト |
| summarise.R | `R/summarise.R` | ソース | `pick()`が使用される主要コンテキスト |
