# 通知設計書 5-sample_n() .env引数非推奨

## 概要

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

### 本通知の処理概要

`sample_n()`関数の`.env`引数は非推奨となり、使用しても効果がなくなった。この通知は、ユーザーが`sample_n()`を`.env`引数付きで呼び出した際に、`inform()`関数を通じて情報メッセージを表示する。

**業務上の目的・背景**：`sample_n()`関数自体がsuperseded（置き換え推奨）となり、`slice_sample()`への移行が推奨されている。この過程で`.env`引数は完全に効果がなくなった。歴史的には`.env`は環境指定に使用されていたが、現在のtidy evaluation機構ではこの引数は不要となった。ユーザーに対して、この引数を使用してもコードに影響がないことを通知し、不要な引数の削除を促す。

**通知の送信タイミング**：ユーザーがRコード内で`sample_n()`関数を`.env`引数にNULL以外の値を指定して呼び出した際に、この通知が発生する。`.env`がNULLの場合は通知されない。

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

**通知内容の概要**：`.env`引数が非推奨であり、効果がなくなった旨が表示される。

**期待されるアクション**：ユーザーは`.env`引数をコードから削除することが期待される。さらに、`sample_n()`自体も`slice_sample()`への移行が推奨されているため、関数自体の置き換えも検討すべきである。

## 通知種別

コンソール情報通知（inform）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（関数呼び出し時即座に表示） |
| 優先度 | 低（情報レベル） |
| リトライ | 無し |

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

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

## 通知テンプレート

### コンソール情報通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | rlang パッケージ（inform関数） |
| 形式 | テキスト |

### 本文テンプレート

```
`sample_n()` argument `.env` is deprecated and no longer has any effect.
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | メッセージは固定テキスト | ハードコード | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 関数呼び出し | `sample_n()`の実行 | `.env`がNULLでない場合 | `.env`引数に値が指定された時のみ |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `.env = NULL`の場合 | デフォルト値のため通知不要 |
| rlangのmessage抑制設定 | `suppressMessages()`で抑制可能 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sample_n.data.frame呼び出し] --> B{.envがNULL?}
    B -->|Yes| C[通知スキップ]
    B -->|No| D[inform実行]
    D --> E[情報メッセージ表示]
    E --> F[処理継続]
    C --> F
    F --> G[size/weightのenquo化]
    G --> H[slice処理実行]
    H --> I[結果返却]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| サイズ超過エラー | sizeがデータの行数より大きく、replace=FALSEの場合 | エラーメッセージ表示、replace=TRUEを推奨 |
| 型エラー | tblがdata.frameでない場合 | 適切なエラーメッセージ表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- `sample_n()`自体がsuperseded（置き換え推奨）であり、`slice_sample()`への移行が推奨されている
- `.env`引数は歴史的な理由で存在するが、現在は完全に無視される
- `sample_n()`はグループ化されたデータフレームにも対応しており、各グループからサンプリングを行う
- 内部的には`slice()`関数を使用して実装されている
- `lifecycle::signal_stage("superseded", "sample_n()")`により、関数自体のsupersededステータスも通知される

---

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

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

### 推奨読解順序

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

`sample_n()`の引数構造とsuperseded状態を理解する。

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

**読解のコツ**: `tbl`, `size`, `replace`, `weight`, `.env`の各引数の役割を把握する。`.env`はデフォルトでNULL。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sample.R | `R/sample.R` | `sample_n()`関数の定義（64-74行目） |
| 2-2 | sample.R | `R/sample.R` | `sample_n.data.frame()`メソッド（90-115行目） |

**主要処理フロー**:
1. **72行目**: `lifecycle::signal_stage("superseded", "sample_n()")` でsuperseded通知
2. **73行目**: `UseMethod("sample_n")` でメソッドディスパッチ
3. **98-101行目**: `.env`がNULLでない場合の`inform()`呼び出し

#### Step 3: 情報通知の実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sample.R | `R/sample.R` | `.env`チェックと`inform()`（98-101行目） |

**条件分岐**:
```r
if (!is_null(.env)) {
  inform(
    "`sample_n()` argument `.env` is deprecated and no longer has any effect."
  )
}
```

#### Step 4: 実際のサンプリング処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | sample.R | `R/sample.R` | `slice()`を使用したサンプリング（107-114行目） |

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

```
sample_n(tbl, size, replace, weight, .env)
    │
    ├─ lifecycle::signal_stage("superseded")
    │      └─ superseded通知
    │
    ├─ UseMethod("sample_n")
    │      │
    │      └─ sample_n.data.frame()
    │             │
    │             ├─ is_null(.env)チェック
    │             │      └─ inform() [.envがNULLでない場合]
    │             │
    │             ├─ enquo(size), enquo(weight)
    │             │
    │             └─ slice(tbl, ...)
    │                    └─ sample.int()
    │
    └─ 結果返却
```

### データフロー図

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

tbl, size, ────▶ sample_n()呼び出し ───────▶ superseded通知（信号）
.env(非NULL)           │
                       ▼
               is_null(.env)チェック ──────▶ 情報メッセージ（stdout）
                       │
                       ▼
               slice() + sample.int() ─────▶ サンプリング結果（data.frame）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sample.R | `R/sample.R` | ソース | `sample_n()`と`sample_frac()`の定義 |
| slice.R | `R/slice.R` | ソース | `slice()`関数（内部で使用） |
| compat-lifecycle.R | `R/compat-lifecycle.R` | ソース | lifecycleパッケージとの互換性 |
| NAMESPACE | `NAMESPACE` | 設定 | エクスポート定義 |
