R语言【rmarkdown】——render():使用 pandoc 将输入文件渲染为指定的输出格式。如果输入需要knit,则在 pandoc 之前调用 knit

Package rmarkdown version 2.25


Parameters

render(
  input,
  output_format = NULL,
  output_file = NULL,
  output_dir = NULL,
  output_options = NULL,
  output_yaml = NULL,
  intermediates_dir = NULL,
  knit_root_dir = NULL,
  runtime = c("auto", "static", "shiny", "shinyrmd", "shiny_prerendered"),
  clean = TRUE,
  params = NULL,
  knit_meta = NULL,
  envir = parent.frame(),
  run_pandoc = TRUE,
  quiet = FALSE,
  encoding = "UTF-8"
)

参数【input】:要渲染的输入文件。可以是 R 脚本(.R)、R Markdown 文档(.Rmd)或纯 Markdown 文档。

参数【output_format】:要转换成的 R Markdown 输出格式。

  • "all" 将显示文件中定义的所有格式。
  • 该选项可以是一种格式的名称(如 "html_document"),这样就能以该格式渲染文档。也可以使用格式名称向量来传递多种格式。或者,也可以传递输出格式对象(例如 html_document())。
  • 如果使用 NULL,则输出格式为输入文件中 YAML frontmatter 中定义的第一种格式(如果没有指定格式,则默认为 HTML)。如果向参数【output_format】传递输出格式对象,YAML 标头_output.yml 中指定的选项将被忽略,您必须在构建对象时明确设置所有选项。如果传递的是字符串,输出格式将使用 YAML 标头_output.yml 中的输出参数。

参数【output_file】:输出文件的名称。

  • 如果使用 NULL,输出文件名将以输入文件的文件名为准。
  • 如果提供了文件名,还可以提供输出文件的路径。请注意,参数【output_dir】选项也允许指定输出文件路径,但如果同时指定路径,则目录必须存在
  • 如果指定了参数【output_file】,但没有文件扩展名,则会根据输出格式自动添加扩展名。
  • 为避免自动文件扩展名,请在 I() 中输入参数【output_file】值,例如 I('my-output')

参数【output_dir】:输出文件的输出目录。

  • 这样就可以选择输出文件应写入的另一个目录(默认输出目录为输入文件的目录)。
  • 如果在参数【output_file】中提供了文件名路径,则此处指定的目录优先。
  • 请注意,如果所提供的目录路径不存在,则将创建任何必要的目录。

参数【output_options】:可覆盖元数据中指定选项的输出选项列表(例如,可用于强制使用 self_containedmathjax = "local")。请注意,只有从元数据中读取输出格式时(即不是将自定义格式对象传递给参数【output_format】),这才有效。

参数【output_yaml】:指定输出格式及其配置的 YAML 文件的路径。将使用第一个现有文件。如果没有找到,则函数会搜索 YAML 前置文件 _output.yml _output.yamloutput_yaml 顶级参数指定的 YAML 文件,然后使用第一个现有文件。

参数【intermediates_dir】:中间文件目录。

  • 如果指定了路径,中间文件将写入该路径。
  • 如果为 NULL,中间文件将写入与输入文件相同的目录。

参数【knit_root_dir】:编织文档的工作目录;使用 knitrroot.dir 编织选项。如果为 NULL,则行为将遵循 knitr 默认设置,即使用文档的父目录。

参数【runtime】:运行时的渲染目标。

  • static 选项产生的输出用于静态文件;
  • shiny 产生的输出适合在 Shiny 文档中使用。
  • 默认情况下,auto 允许优先使用 YAML 元数据中指定的运行时目标,否则将渲染静态运行时目标。

参数【clean】:使用 TRUE 会清除渲染过程中创建的中间文件。

参数【params】:已命名参数的列表,可覆盖 YAML 前置内容中指定的自定义参数(例如,指定要读取的数据集或限制输出的日期范围)。通过 "ask" 启动一个应用程序,帮助指导参数配置。

参数【knit_meta】:(此选项仅供专家使用。)元数据由 knitr 生成。

参数【envir】:编织过程中运行代码块的环境(可以使用 new.env() 来保证新环境为空)。

参数【run_pandoc】:是否运行 pandoc 转换 Markdown 输出的选项。

参数【quiet】:一个选项,用于在从 knitrpandoc 命令行和其他程序渲染时抑制打印。要只抑制打印最后一条 "已创建输出: "信息,可将 rmarkdown.render.message 设为 FALSE

参数【encoding】:忽略。编码总是假定为 UTF-8。

你可能感兴趣的:(R语言,r语言,前端,java)