tflspec ブラッシュアップ — 開発チームで決めること

[ichirio]

tflspec のブラッシュアップ（各 Spec の仕様と、Spec ⇄ コード ⇄ オブジェクトの変換の見直し）で、開発チームで決めることの一覧です。次回のミーティングで決めます。

• 各項目に「決めること」と「案」を書いています。案でよければ、何もしなくて構いません。
• 異論や意見は、その項目のコメントに Quote reply でお願いします。
• 項目は、ブラッシュアップの進み具合に応じて追加します。

#	決めること	案
1	図の Spec が 2 種類（Excel の tfl_fig_spec と YAML の tfl_fig_design）あるのを、1 つにするか	YAML に一本化する（Excel 版は廃止）
2	存在しない帳票 ID で table spec を読んだら、エラーにするか	エラーにする（既定の行だけで作るときは output_id = NULL）

[ichirio]

1. 図の Spec を YAML に一本化しますか？

今は図の Spec が 2 種類あります：Excel の tfl_fig_spec（初期の形）と、YAML の tfl_fig_design（ggplot2 の全機能を書ける今の形）。

• 案：YAML（tfl_fig_design）に一本化し、Excel 版（tfl_fig_spec / tfl_read_fig_spec / tfl_fig_spec_template など）は廃止する。
• ほか：両方残す。
• 理由・影響：同じ図を 2 通りに書けると、覚えることも保守も倍になります。tflplanner の図の画面は、すでに YAML 版だけを使っています。
  Excel 版の図の Spec を自分で使っている場合は、書き換えが必要です（使っている方はコメントください）。

[ichirio]

メンテナの意見（tflplanner を実際に使って）：図の作り方の主力は次の 2 つで、どちらも YAML の図 Spec を作る形がよいと考えます。

1. テンプレートから選んで、パラメータを設定する
2. プロットデザイナーで、ggplot()・レイヤー・全体の設定を GUI で組み立てる

コードを書く図は、上の 2 つで書けないときの最終手段として、別の共通の仕組み（ユーザーがコードを用意する帳票）にする予定です。項目 1 は、この方向で「YAML に一本化」を推します。

[ichirio]

2. 存在しない帳票 ID で table spec を読んだら、エラーにしますか？

tfl_read_table_spec(path, output_id = "X") で、どのシートにも X の行がないとき、今はメッセージを出して既定の見た目の表を作ります。

• 案：エラーにする（「X の行がありません。ある ID は …」）。既定の行だけで作りたいときは output_id = NULL で読む。
• ほか：今のまま／オプションで切り替える。
• 理由・影響：今の動きだと、ID を打ち間違えても別の表が黙ってでき、RTF まで出てしまいます。
  一方、表の行を持たない帳票 ID を、表のワークブックだけで読んでいるコードはエラーになります（tflplanner と同梱の見本は影響なし）。