R中kableExtra生成github_document时下划线转义错误问题

问题原因 #

该问题是双重转义导致：你手动为下划线添加了转义反斜杠，同时kable默认开启的escape=TRUE参数会自动对特殊字符（含反斜杠、下划线）做二次转义，最终渲染到文档里的内容就会出现多余的反斜杠。

修复步骤 #

1. 移除手动转义符 #

定义数据集时，df_name列直接输入带下划线的原始文本即可，不需要手动加\\转义：

names_table <- data.frame(
  name = c("Heat Index", "Heat Index Extreme Caution", "Heat Index Dangerous", "Temperature over the 95th percentile"), 
  df_name = c("heat_index", "heat_index_ec", "heat_index_dan", "temp_over_95_pctl"), 
  calculation = c("Heat index calculation", "Temperature between 90-102F", "Temperature between 103-124F", "Temperature exceeds historic 95th pctl")
)

2. 调整kable转义参数 #

你使用的是HTML格式输出表格，GitHub渲染HTML内容时不会把文本内的下划线识别为Markdown格式标记，直接关闭kable的自动转义即可：

names_table %>% 
  knitr::kable(
    col.names = c("Variable Name", "Column Name", "Variable Calculation"),
    escape = FALSE, # 此处由TRUE改为FALSE
    format = "html"
  ) %>% 
  kable_styling(
    bootstrap_options = c("striped", "hover", "condensed"),
    full_width = F,
    position = "center"
  ) %>%
  column_spec(3, width = "20em")

特殊场景适配 #

如果表格内同时存在需要转义的特殊字符（如<、>、&），无需关闭全局转义，单独给df_name列标记为原生HTML文本即可：

library(htmltools)
names_table$df_name <- HTML(names_table$df_name)

之后保持kable的escape=TRUE配置运行代码即可。

内容的提问来源于stack exchange，提问作者janelle88