パッケージでの ggplot2 の使用

ggplot2 の関数を参照する

他のパッケージからの関数と同様に、DESCRIPTION の Imports に ggplot2 を列挙し、:: を使用してその関数を参照する必要があります (例: ggplot2::function_name)。:

mpg_drv_summary <- function() {
  ggplot2::ggplot(ggplot2::mpg) + 
    ggplot2::geom_bar(ggplot2::aes(x = .data$drv)) + 
    ggplot2::coord_flip()
}

ggplot2 の関数を頻繁に使用する場合，ggplot2 から1つ以上の関数を自分のNAMESPACEにインポートしたいと思うかもしれません。 roxygen2 を使用している場合、任意の roxygen コメントブロックに #' @importFrom ggplot2 <1つ以上のオブジェクト名> を含めることができます（これは mpg のようなデータセットには使えません）。

#' @importFrom ggplot2 ggplot aes geom_bar coord_flip
mpg_drv_summary <- function() {
  ggplot(ggplot2::mpg) + 
    geom_bar(aes(x = drv)) + 
    coord_flip()
}

あなたのパッケージで多くの ggplot2 関数を使用する場合でも、Depends で ggplot2 を使用したり、パッケージ全体をあなたの NAMESPACE にインポートすることは賢明ではありません (例えば、#' @import ggplot2 を使用します)。 Depends で ggplot2 を使用すると、あなたのパッケージがアタッチされたときに ggplot2 がアタッチされますが、これにはあなたのパッケージがテストされたときも含まれます。 これにより、他の人がパッケージをアタッチせずに(すなわち、:: を使用して)あなたのパッケージ内の関数を使用できることを保証することが難しくなります。 同様に、あなたの名前空間に ggplot2 の 450個のエクスポートされたオブジェクトのすべてをインポートすることは、あなたのパッケージの責任と ggplot2 の責任を分離することを困難にし、加えて、あなたのコードの読者が関数がどこから来ているのかを理解することを困難にします。

パッケージ関数での aes() と vars() の使用

ggplot2 を使ってグラフィックを作成する場合、おそらく一度は aes() を使う必要があるでしょう。また、グラフィックが facet を使用している場合、プロット/レイヤーデータの列を参照するために、vars() を使用しているかもしれません。 これらの関数はいずれも非標準的な評価を行うため、パッケージ内の関数で使おうとすると、CMD check ノートが表示されます。:

mpg_drv_summary <- function() {
  ggplot(ggplot2::mpg) + 
    geom_bar(aes(x = drv)) + 
    coord_flip()
}

N  checking R code for possible problems (2.7s)
   mpg_drv_summary: no visible binding for global variable ‘drv’
   Undefined global functions or variables:
     drv

この問題に遭遇するのは3つの状況です。

• 事前に列名や式がわかっている場合。
• 文字ベクトルとして列名を持っている場合。
• ユーザが列名や式を指定し、aes() や vars() で使われているような非標準的な評価を自分の関数にさせたい。

もし、（上の例のように）事前にマッピングがわかっている場合は、rlangの .data という代名詞を使って、 レイヤーデータの中の drv を参照しているのであって、drv という名前の他の変数（他の場所に存在するかもしれないし、存在しないかもしれない）を参照しているのではないことを明示してください。 CMD check で .data についての同様の注意を避けるために、あらゆる roxygen のコードブロックで #' @importFrom rlang .data を使用してください （通常、これは usethis::use_package_doc() で生成されたパッケージドキュメントの中にあるはずです）。

mpg_drv_summary <- function() {
  ggplot(ggplot2::mpg) + 
    geom_bar(aes(x = .data$drv)) + 
    coord_flip()
}

列名が文字ベクトルの場合（例：col = "drv"）、.data[[col]] を使用します。:

col_summary <- function(df, col) {
  ggplot(df) + 
    geom_bar(aes(x = .data[[col]])) + 
    coord_flip()
}

col_summary(mpg, "drv")

列名や式がユーザーによって提供される場合は、{{ col }}を使って aes() や vars() に渡すこともできます。 この tidy eval 演算子は、ユーザーによって供給された式を捕捉し、それを aes() や vars() などの別の tidy eval 対応関数に転送します。

col_summary <- function(df, col) {
  ggplot(df) + 
    geom_bar(aes(x = {{ col }})) + 
    coord_flip()
}

col_summary(mpg, drv)

要約すると

• マッピングや facet の仕様が col であることが事前に分かっている場合は、aes(.data$col) や vars(.data$col) を使用してください。
• colが文字ベクトルとしてカラム名を含む変数である場合には、aes(.data[[col]]またはvars(.data[[col]])` を使用してください。
• colの動作をaes()やvars()のようにしたい場合は、aes({{ col }})やvars({{ col }})` を使用してください。

他にも様々な方法がありますが、ここで使用している構文は将来的にも動作することが保証されている唯一の構文です。 特に、aes_() や aes_string() は非推奨であり、将来のバージョンで削除される可能性があるため、使用しないでください。 最後に、データフレームとマッピングを作成して ggplot() やそのレイヤーに渡すステップを省略しないでください。 最後に、ggplot()やそのレイヤーに渡すデータフレームとマッピングを作成するステップを省略しないでください！ 他の方法もありますが、文書化されていない動作に依存していたり、予期せぬ方法で失敗することがあります。

一般的なタスクのベストプラクティス

mpg_drv_dist <- structure(
  c(
    "4" = 103 / 234,
    "f" = 106 / 234,
    "r" = 25 / 234
  ),
  class = "discrete_distr"
)

discrete_distr_data <- function(x) {
  tibble::tibble(
    value = names(x),
    probability = as.numeric(x)
  )
}

discrete_distr_data(mpg_drv_dist)
#> # A tibble: 3 x 2
#>   value probability
#>   <chr>       <dbl>
#> 1 4           0.440
#> 2 f           0.453
#> 3 r           0.107

#' @importFrom ggplot2 autoplot
autoplot.discrete_distr <- function(object, ...) {
  plot_data <- discrete_distr_data(object)
  ggplot(plot_data, aes(.data$value, .data$probability)) +
    geom_col() +
    coord_flip() +
    labs(x = "Value", y = "Probability")
}

#' @importFrom graphics plot
plot.discrete_distr <- function(x, ...) {
  print(autoplot(x, ...))
}

#' @importFrom ggplot2 %+replace%
theme_custom <- function(...) {
  theme_grey(...) %+replace% 
    theme(
      panel.border = element_rect(size = 1, fill = NA),
      panel.background = element_blank(),
      panel.grid = element_line(colour = "grey80")
    )
}

mpg_drv_summary() + theme_custom()

default_theme <- function() {
  theme_custom()
}

mpg_drv_summary2 <- function() {
  mpg_drv_summary() + default_theme()
}

test_that("ggplot()の出力は安定している", {)
  vdiffr::expect_doppelganger("A blank plot", ggplot())
})

theme_custom <- function(...) {
  `%+replace%` <- ggplot2::`%+replace%`
  
  ggplot2::theme_grey(...) %+replace% 
    ggplot2::theme(panel.background = ggplot2::element_blank())
}

.onLoad <- function(...) {
  if (requireNamespace("ggplot2", quietly = TRUE)) {
    vctrs::s3_register("ggplot2::autoplot", "discrete_distr")
  }
}