2016-11-15 78 views
3

是否可以在R中爲所有新腳本創建默認評論標題模板?在R中創建默認評論標題模板?

我通常在所有腳本的頂部包含一些標準信息,並希望自動創建註釋標題的過程。

例如:

################################################## 
## Project: 
## Script purpose: 
## Date: 
## Author: 
################################################## 
+1

假設你正在使用rstudio(R和rstudio是獨立軟件件),你可能有一個看比較新的代碼片斷功能在rstudio,概述[這裏](https://support.rstudio.com/hc/EN-US /用品/ 204463668-代碼片段)。這不完全正確,但可能會讓你非常接近。 – lmo

+0

謝謝!我覺得這其實是一個更好的選擇,因爲它可以讓我做(和輕鬆插入)不同格式的註釋頭(例如:功能腳本,清除腳本,閃亮的應用等) – TClavelle

+0

此外,@lmo請給予好評,如果你的問題發現它很有趣/有用! – TClavelle

回答

3

我不知道你是否能直接做,但你可以通過將按照您的Rprofile接近它。

make_r_template <- function(filename = "r_template.R", dir = getwd()) 
{ 
    if (file.exists(file.path(dir, filename))) invisible(NULL) 
    else{ 
    write(c("##################################################", 
      "## Project:", 
      "## Script purpose:", 
      "## Date:", 
      "## Author:", 
      "##################################################"), 
      file = file.path(dir, filename), 
      sep = "\n") 
    } 
} 

make_r_template() 

這將運行每個R在時間和空白模板編寫工作目錄,只要它不存在。您也可以在任何點使用不同的filename值在其他位置創建空白模板。

一個很好的補充觸摸將是第二個函數,它查看文件,嘗試識別標題,並在未找到標題時插入它。

2

在從@lmo以上的建議,我創建了RStudio兩個新的代碼片段通過編輯位於片段文件Preferences > Code > Edit Snippets

注:代碼段的定義之下,必須使用選項卡被縮進和不是兩個空格

片段1:評論標題爲新腳本

snippet header_script 
    ################################################## 
    ## Project: 
    ## Script purpose: 
    ## Date: 
    ## Author: 
    ################################################## 

片段2:評論標題爲腳本中的代碼段:

snippet header_section 
    ## Section: 
    ################################################## 

現在,每當我想插入一個給定的頭,我剛開始輸入段的名字(例如header_script),請從自動完成菜單中進行選擇(完成後請輸入而不是),然後按回車鍵以插入評論標題。