
本文详细介绍了如何在r markdown中配置plotly图表,以实现`partial_bundle`功能的离线运行并有效减小html文件体积。核心方法是通过手动管理plotly的javascript依赖,将其从在线cdn或临时文件路径转移至本地存储,并更新图表对象的依赖引用。这确保了即使在无网络环境下,r markdown也能生成包含精简plotly图表的html报告,同时提供详细的步骤、代码示例及注意事项。
在R Markdown中嵌入交互式Plotly图表时,使用partial_bundle()函数可以显著减小最终HTML文件的大小,因为它只加载Plotly所需的核心JavaScript功能。然而,默认情况下,partial_bundle()会尝试从CDN(内容分发网络)下载必要的JavaScript脚本,这要求在渲染R Markdown时具备网络连接。对于需要在离线环境或对文件依赖有严格控制的场景,将Plotly的JavaScript依赖本地化是必要的。本教程将指导您完成这一过程,确保Plotly图表在R Markdown中能够离线且高效地工作。
1. 理解Plotly的依赖管理与partial_bundle()
当您在Plotly图表上调用partial_bundle()时,Plotly会动态判断并加载最精简的JavaScript文件,通常是plotly-basic.min.js。在首次调用时,这个文件会被下载到一个临时位置,或者尝试从CDN加载。我们的目标是将这个临时文件或CDN上的文件永久保存到本地,并修改Plotly图表的依赖指向这个本地文件。
首先,让我们创建一个简单的Plotly图表并查看其依赖项,以了解partial_bundle()的初始行为。
library(plotly)library(htmltools) # 用于处理HTML依赖# 示例数据data(hobbs, package="plotly") # 创建一个使用 partial_bundle() 的Plotly图表plt % partial_bundle()plt # 预览图表# 检查图表的依赖项# 通常 'plotly-basic' 是我们关注的第五个依赖项invisible(lapply(1:length(plt$dependencies), function(k) message(plt$dependencies[[k]]$name)))# 查看 'plotly-basic' 依赖的详细信息plotly_basic_dep <- plt$dependencies[[which(sapply(plt$dependencies, function(d) d$name == "plotly-basic"))]]print(plotly_basic_dep)
从plotly_basic_dep的输出中,您会看到src字段包含href(CDN链接)和file(临时文件路径)。script字段则指明了JavaScript文件的具体名称,例如plotly-basic-2.5.1.min.js。这表明该文件已下载到您的系统临时目录。
立即学习“前端免费学习笔记(深入)”;
# 示例输出片段 (您的临时路径会不同)# $name : chr "plotly-basic"# $version : chr "2.5.1"# $src :List of 2# ..$ href: chr "https://cdn.plot.ly"# ..$ file: chr "/var/folders/zp/rgt0rwln7xq132_rnrmhfb400000gn/T//RtmpFtB0bB"# $script : chr "plotly-basic-2.5.1.min.js"
2. 获取并本地存储JavaScript文件
您有两种主要方式获取并存储JavaScript文件:从临时目录复制或从CDN下载。
2.1 从临时目录复制文件(推荐)
由于partial_bundle()已经将文件下载到了临时目录,最简单的方法就是将其复制到您希望的永久位置。
# 获取临时文件路径和文件名temp_file_path <- plotly_basic_dep$src$filescript_name <- plotly_basic_dep$scriptfull_temp_path <- file.path(temp_file_path, script_name)# 目标存储位置:Plotly包的htmlwidgets/lib/plotlyjs子目录# 这种方式将文件集成到Plotly包的内部结构中,对所有项目通用plotly_lib_path <- system.file(package = "plotly", "htmlwidgets/lib/plotlyjs")# 确保目标目录存在if (!dir.exists(plotly_lib_path)) { dir.create(plotly_lib_path, recursive = TRUE)}# 复制文件file.copy(from = full_temp_path, to = file.path(plotly_lib_path, script_name), overwrite = TRUE)# 验证文件是否已复制list.files(plotly_lib_path)
注意事项:
将文件复制到Plotly包的库目录是一个“一劳永逸”的解决方案,只要Plotly包不更新,所有使用该R环境的项目都能受益。如果Plotly包更新,您可能需要重复此步骤以获取最新版本的plotly-basic.min.js。如果您不希望修改R包的内部结构,也可以选择将其复制到您的项目文件夹(例如,./www/plotlyjs/),但需要确保R Markdown能够找到该路径。
2.2 从CDN下载文件(备选)
如果您无法访问临时文件,或者出于其他原因,可以直接从CDN下载文件。
# 构建完整的CDN链接cdn_link <- with(plotly_basic_dep, paste0(src$href, "/", script))# 定义本地保存路径 (例如,在当前工作目录下的'www/plotlyjs'中)local_save_dir <- "www/plotlyjs"if (!dir.exists(local_save_dir)) { dir.create(local_save_dir, recursive = TRUE)}local_dest_file <- file.path(local_save_dir, script_name)# 下载文件download.file(url = cdn_link, destfile = local_dest_file)# 验证文件是否下载list.files(local_save_dir)
3. 创建并替换Plotly图表的本地依赖
文件存储在本地后,我们需要创建一个新的htmltools::htmlDependency对象,指向这个本地文件,并替换Plotly图表原有的依赖。
htmltools::htmlDependency函数是定义HTML资源依赖的关键。其主要参数包括:
name: 依赖项的名称,与原始依赖项保持一致(如”plotly-basic”)。version: 依赖项的版本,与原始依赖项保持一致(如”2.5.1″)。src: 资源所在的目录。这是最关键的参数,它定义了R Markdown查找JavaScript文件的位置。script: JavaScript文件的名称。package: 如果src路径是R包内部的相对路径,则需要指定package名称。all_files: 一个逻辑值,指示是否包含src目录下的所有文件。如果src指向一个包含多个文件的目录且您只引用其中一个,通常设为FALSE。对于R包内部路径,通常可以省略或设为TRUE。
3.1 针对存储在Plotly库中的文件
如果JavaScript文件存储在Plotly包的htmlwidgets/lib/plotlyjs子目录中,src路径应为相对于包根目录的相对路径,并指定package = “plotly”。
# 创建新的本地依赖对象 (针对存储在Plotly库中的情况)local_pbund_lib <- htmltools::htmlDependency( name = plotly_basic_dep$name, version = plotly_basic_dep$version, src = "htmlwidgets/lib/plotlyjs", # 相对于plotly包根目录的路径 script = plotly_basic_dep$script, package = "plotly" # 指定包名)# 替换图表中的依赖# 找到 'plotly-basic' 依赖的索引dep_index <- which(sapply(plt$dependencies, function(d) d$name == "plotly-basic"))plt$dependencies[[dep_index]] <- local_pbund_lib# 再次检查依赖,确认已更新print(plt$dependencies[[dep_index]])# 渲染图表,此时将使用本地依赖plt
3.2 针对存储在其他本地目录中的文件
如果JavaScript文件存储在您的项目目录(例如./www/plotlyjs/)中,src路径应是相对于R Markdown文件或项目根目录的相对路径。此时,package参数不需要指定,且all_files通常应设为FALSE。
# 假设文件存储在当前RMD文件同级目录下的 'www/plotlyjs'# local_save_dir <- "www/plotlyjs" # 从上一节获取# 创建新的本地依赖对象 (针对存储在其他本地目录的情况)local_pbund_other <- htmltools::htmlDependency( name = plotly_basic_dep$name, version = plotly_basic_dep$version, src = local_save_dir, # 指向本地目录的相对路径或绝对路径 script = plotly_basic_dep$script, all_files = FALSE # 通常设为FALSE,除非您想包含整个目录)# 替换图表中的依赖# 找到 'plotly-basic' 依赖的索引dep_index <- which(sapply(plt$dependencies, function(d) d$name == "plotly-basic"))plt$dependencies[[dep_index]] <- local_pbund_other# 再次检查依赖,确认已更新print(plt$dependencies[[dep_index]])# 渲染图表,此时将使用本地依赖plt
4. 完整示例工作流
以下是一个将所有步骤整合在一起的完整R Markdown代码块示例,它将Plotly的plotly-basic脚本复制到Plotly包的内部库路径,并相应地更新图表依赖。
# R Markdown Chunk Options: eval=TRUE, include=TRUE# 确保在R Markdown环境中运行,或在R脚本中运行一次以设置依赖library(plotly)library(htmltools)# 1. 创建一个Plotly图表并触发 partial_bundle(),使其下载脚本到临时目录data(hobbs, package="plotly") plt % partial_bundle()# 2. 获取 'plotly-basic' 依赖的详细信息plotly_basic_dep <- plt$dependencies[[which(sapply(plt$dependencies, function(d) d$name == "plotly-basic"))]]# 3. 确定源文件和目标位置temp_file_path <- plotly_basic_dep$src$filescript_name <- plotly_basic_dep$scriptfull_temp_path <- file.path(temp_file_path, script_name)plotly_lib_path <- system.file(package = "plotly", "htmlwidgets/lib/plotlyjs")# 4. 复制文件到Plotly库目录 (仅需运行一次,或当Plotly更新时)if (!file.exists(file.path(plotly_lib_path, script_name))) { message("复制 ", script_name, " 到 Plotly 库目录...") if (!dir.exists(plotly_lib_path)) { dir.create(plotly_lib_path, recursive = TRUE) } file.copy(from = full_temp_path, to = file.path(plotly_lib_path, script_name), overwrite = TRUE) message("复制完成。")} else { message(script_name, " 已存在于 Plotly 库目录。")}# 5. 创建新的本地依赖对象local_pbund <- htmltools::htmlDependency( name = plotly_basic_dep$name, version = plotly_basic_dep$version, src = "htmlwidgets/lib/plotlyjs", script = plotly_basic_dep$script, package = "plotly" )# 6. 替换图表中的依赖dep_index <- which(sapply(plt$dependencies, function(d) d$name == "plotly-basic"))plt$dependencies[[dep_index]] <- local_pbund# 7. 显示图表plt
5. 注意事项与总结
执行频率: 将JavaScript文件复制到本地目录(特别是R包库目录)的步骤,通常只需要在首次设置、R环境迁移或Plotly包更新后执行一次。在R Markdown中,可以将这部分代码放在一个独立的R chunk中,并设置eval=FALSE,只在需要时手动执行。路径管理: 确保htmltools::htmlDependency中的src路径正确指向您存储JavaScript文件的位置。如果是R包内部路径,务必指定package参数。如果是项目内的相对路径,则不需要package参数,且all_files = FALSE通常是更安全的做法。版本一致性: 确保您复制的JavaScript文件版本与htmltools::htmlDependency中指定的version参数一致,这有助于避免潜在的兼容性问题。R Markdown渲染: 当您在R Markdown中渲染HTML报告时,只要图表对象的依赖已被正确修改为指向本地文件,R Markdown就不会尝试从网络下载脚本,从而实现离线渲染并减小HTML文件体积。
通过遵循本教程的步骤,您可以有效地管理Plotly在R Markdown中的JavaScript依赖,实现离线渲染和文件优化,从而提高报告的灵活性和可移植性。
以上就是优化R Markdown中Plotly图表的离线依赖管理以减小HTML文件大小的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1585753.html
微信扫一扫
支付宝扫一扫