checkRd 位於 tools 包(package)。 說明
檢查幫助文件或 parse_Rd 函數的輸出。
用法
checkRd(Rd, defines = .Platform$OS.type, stages = "render",
unknownOK = TRUE, listOK = TRUE, ..., def_enc = FALSE)
參數
Rd |
用作輸入的文件名或 |
defines |
|
stages |
|
unknownOK |
如果 |
listOK |
如果 |
... |
當 |
def_enc |
邏輯：包是否聲明了編碼，因此對非 ASCII 文本的測試被抑製？ |
細節
checkRd 對 Rd 文件執行一致性檢查，確認所需部分是否存在等。
它接受 Rd 文件的文件名，並在應用檢查之前使用 parse_Rd 對其進行解析。如果是這樣，則收集來自 parse_Rd 的警告以及來自內部函數 prepare_Rd 的警告，該函數執行 #ifdef 和 \Sexpr 處理，刪除不會渲染或重複(也不應該)的部分並刪除空白部分。
Rd 對象通過 prepare_Rd 傳遞，但它可能已經傳遞(並且已安裝的 Rd 對象已經傳遞)。
警告為 ‘level’：來自 prepare_Rd 的警告級別為 0。其中包括
\Sexpr 需要 R 代碼；成立 ... |
未處理的‘階段’ 宏來自階段-階段\Sexpr |
| 所有文本必須位於一個部分中 |
| 隻有一個標簽名允許使用第一個部分：將使用第一個部分 |
| 文檔類型類型未被識別 |
| 部分名字無法識別並將被丟棄 |
| 刪除空部分名字 |
checkRd本身可以顯示
| 7 | 標簽標簽名未能識別 |
| 7 | 無法識別的格式：... |
| 7 | \tabular 格式必須是簡單文本 |
| 7 | 無法識別的 \tabular 格式：... |
| 7 | 僅有的n該表中允許的列 |
| 7 | 標簽標簽名在 a 中無效區塊名稱堵塞 |
| 7 | \method 在代碼塊之外無效 |
| 7 | 標簽\method僅在\usage中有效 |
| 7 | 標簽\dontrun僅在\examples中有效 |
| 7 | 無效的郵件地址： ... |
| 7 | 無效的網址： ... |
| 5 | \item在區塊名稱必須有非空標簽 |
| 3 | 空部分標簽名 |
| -1 | 未聲明編碼的非 ASCII 內容 |
| -1 | \enc 第二部分中的非 ASCII 內容 |
| -1 | 逃脫LaTeX特價：... |
| -3 | 標簽 \ldots 在代碼塊中無效 |
| -3 | 不必要的牙套... |
| -5 | \title 不應以句點結尾 |
以及 \method 替換為 \S3method 或 \S4method 、 \dontrun 替換為 \donttest 或 \dontshow 以及 \title 替換為 \section 或 \subsection 名稱的變體。
請注意，prepare_Rd 和 checkRd 都有針對空部分的測試：checkRd 中的測試更嚴格(本質上不輸出任何內容)。
值
這可能會失敗R錯誤，但否則警告會作為類對象返回"checkRd"，消息的字符向量。這個類有一個print隻打印唯一消息並有參數的方法minlevel可用於僅選擇更嚴重的消息。 (這被設置為-1在R CMD check.)
可能的致命錯誤來自 !unknownOK 或 !listOK 、無效的 \if 或 \ifelse 條件、運行解析器(例如，不存在的文件、未閉合的帶引號的字符串、沒有指定編碼的非 ASCII 輸入) 、\Sexpr 選項的無效值)，或來自 prepare_Rd(多個 \Rdversion 聲明、無效的 \encoding 或 \docType 或 \name 部分，以及丟失或重複的 \name 或 \title 部分)，包括從 \Sexpr 宏解析/運行代碼產生的錯誤(如果被 stages 覆蓋)。
作者
Duncan Murdoch, Brian Ripley
也可以看看
相關用法
- R checkRdaFiles 報告已保存圖像的詳細信息或重新保存它們
- R checkVignettes 檢查包裝插圖
- R checkMD5sums 檢查並創建 MD5 校驗和文件
- R checkFF 檢查外部函數調用
- R checkTnF 檢查 R 包或 T/F 代碼
- R checkPoFiles 檢查翻譯文件中格式字符串不一致的情況
- R check_packages_in_dir 檢查源碼包及其反向依賴
- R charsets 字符集之間的轉換表
- R codoc 檢查代碼/文檔的一致性
- R compactPDF 壓縮 PDF 文件
- R update_PACKAGES 更新現有的 PACKAGES 文件
- R print.via.format 打印實用程序
- R prepare_Rd 準備用於渲染的解析 Rd 對象
- R startDynamicHelp 啟動動態 HTML 幫助係統
- R getVignetteInfo 獲取有關已安裝 Vignettes 的信息
- R matchConcordance 源行和目標行之間的一致性
- R Rd2HTML 路轉換器
- R HTMLheader 為 R 幫助生成標準 HTML 標頭
- R undoc 查找未記錄的對象
- R vignetteInfo 有關暈影的基本信息
- R HTMLlinks 從包文檔收集 HTML 鏈接
- R xgettext 從包中的 R 文件中提取可翻譯消息
- R toTitleCase 將標題轉換為標題大小寫
- R package_native_routine_registration_skeleton 編寫用於將本機例程注冊添加到包的框架
- R parse_Rd 解析 Rd 文件
注：本文由純淨天空篩選整理自R-devel大神的英文原創作品 Check an Rd Object。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。