keep_md編

先の例からbase_html_format$keep_mdはTRUEです。

base_html_format$keep_md
#> [1] TRUE

rmarkdown::output_format関数のbase_formatにbase_html_formatを指定した上で、 keep_md引数にFALSEを指定すると、返り値の$keep_mdはFALSEに改変されます。

modified_html_format <- rmarkdown::output_format(
  knitr = NULL,
  pandoc = NULL,
  keep_md = FALSE,
  base_format = base_html_format
)

modified_html_format$keep_md
#> [1] FALSE

では他の値はどうでしょうか？それぞれの要素がbaseとmodifiedとでidenticalか確認してみましょう。すると、clean_supportingとon_exitも改変されているようです。

str(Map(identical, base_html_format, modified_html_format))
#> List of 11
#>  $ knitr                  : logi TRUE
#>  $ pandoc                 : logi TRUE
#>  $ keep_md                : logi FALSE
#>  $ clean_supporting       : logi FALSE
#>  $ df_print               : logi TRUE
#>  $ pre_knit               : logi TRUE
#>  $ post_knit              : logi TRUE
#>  $ pre_processor          : logi TRUE
#>  $ intermediates_generator: logi TRUE
#>  $ post_processor         : logi TRUE
#>  $ on_exit                : logi FALSE

output_formatのclean_supporting引数はレンダリングに際して出力した画像ファイルなどを掃除するか決めます。 rmarkdown::html_documentの場合、self_contained引数の値がそのままclean_supporting引数に渡されます。これにより、self_contained = FALSEで参照すべき画像ファイルを残す必要があれば、clean_supporting = FALSEが指定されます。 self_contained引数の既定値はTRUEですが、clean_supporting引数の既定値はFALSEなので、上書きされてしまったわけですね。

c(
  formals(rmarkdown::output_format)$clean_supporting,
  formals(rmarkdown::html_document)$self_contained
)
#> [1] TRUE TRUE

on_exitについては環境が変わっただけで、基本的には同じものと思って頂いてOKです。もし、rmarkdown::output_format関数のon_exit引数に関数を指定していた場合は、レンダリング終了時にbase_formatのon_exit要素を実行したあとで、追加指定されたon_exitを実行します ¹。

modified_html_format$base_format
#> NULL

modified_html_format$on_exit
#> function () 
#> {
#>     if (is.function(base)) 
#>         base()
#>     if (is.function(overlay)) 
#>         overlay()
#> }
#> <bytecode: 0x55e41fbfc0e0>
#> <environment: 0x55e41f5d3d20>

knitr編

base_html_format変数のknitr要素は以下のようになっています。

str(base_html_format$knitr)
#> List of 5
#>  $ opts_knit    : NULL
#>  $ opts_chunk   :List of 4
#>   ..$ dev       : chr "png"
#>   ..$ dpi       : num 96
#>   ..$ fig.width : num 7
#>   ..$ fig.height: num 5
#>  $ knit_hooks   : NULL
#>  $ opts_hooks   : NULL
#>  $ opts_template: NULL

では、output_formatに以下のnew_knitrを与えるとどうなるでしょうか？

new_knitr <- list(
  opts_chunk = list(dev = "jpeg")
)

html_format_with_jpeg <- rmarkdown::output_format(
  knitr = new_knitr,
  pandoc = NULL,
  base_format = base_html_format
)

1. knitr要素が完全にnew_knitrに置き換えられる
2. knitr要素のopts_chunk要素だけが置き換えられる
3. knitr要素のopts_chunk要素のdev要素だけが置き換えられる

答えを見てみましょう。

str(html_format_with_jpeg$knitr)
#> List of 5
#>  $ opts_knit    : NULL
#>  $ opts_chunk   :List of 4
#>   ..$ dpi       : num 96
#>   ..$ fig.width : num 7
#>   ..$ fig.height: num 5
#>   ..$ dev       : chr "jpeg"
#>  $ knit_hooks   : NULL
#>  $ opts_hooks   : NULL
#>  $ opts_template: NULL

3の

knitr要素のopts_chunk要素のdev要素だけが置き換えられる

でした！