19 コーディング規約
Rに限らず、どのようなプログラミング言語を用いる場合においても、読みやすいコードと読みにくいコードがあります。また、変数や関数の名前はわかりやすくつけておかないと、後々どのような意味の変数・関数であったかを理解しにくくなってしまいます。
このような、コードの問題、変数や関数の名前の問題をできるだけ抑えるために、企業などでプログラミングを行う場合には、その組織のコーディング規約(coding style)、つまりコードの書き方のルールを設けるのが一般的です。
Rは大学の研究室などで、教官や学生などが小規模なデータの分析に用いる場合も多いため、コーディング規約は必ずしも重要ではありませんが、コードの可読性を高め、解析の再現性(reproducibility)を担保するためにコーディング規約に基づいたプログラミングを心がけた方が良いでしょう。
Rのコーディング規約では、tidyverseに従ったもの(tidyverse style guide)が主流だと思います。
Rには、styler
(Müller and Walthert 2023)やformatR
(Xie 2023)という、coding styleを修正してくれるライブラリや、Rstudioのコーディング規約修正(reformat code)のショートカット(Ctrl+Shift+A)などが備わっており、ある程度自動的にフォーマットの修正を行うことができますので、このような機能を用いるのもよいでしょう。
詳細なRでのコーディング規約の説明は他の文献に譲ります。
例えば、英語であればtidyverse style guideやGoogle’s R Style Guide、日本語であれば「私たちのR ベストプラクティスの探求」(宋財泫先生、矢内勇生先生)の11章やこのZennのページ、こちらのCoding styleのページなどがコーディング規約の参考になります。
コーディングスタイル全体については、リーダブルコード (Boswell and Foucher 2012)を読んでみるのが良いでしょう。関数や変数の名前に悩んだ場合には、良い名前を提案してくれるサイト(codic)も役に立ちます。