關於R function的幾點小事

寫好function一點都不簡單,這邊分享和整理在撰寫function要思考的事情。而這邊主要是講R語言裡的function,但其實很多觀念是可以供通的,可以分別為:一個function的組成什麼是好的function各種function的類型何時要寫function撰寫function的流程。

function是一連串expression包裝(encapsulate)起來而成,expression的多寡決定一個function可以處理事情的多寡,恰當好處的功能,是一個好function的關鍵,能解決問題的function就是有用的,而function裡面細節的設計則決定會不會讓使用者愛用。

首先,理解在R裡面,一個 function基本由什麼組成:

  • 參數arguments
    • 可以使用formals()檢視
  • 主體的代碼body:
    • 可以使用body()檢視
  • 函數中使用變數對應的“變數空間”environment:
    • 可以使用environment()檢視

再來理解,怎麼樣是一個好的function:

  1. 能解決當下問題(最重要)
  2. 易讀性
  3. 輸入輸出高穩定性(stable / pure function )
  4. 對於錯誤訊息的處理(error handling)
  5. 減少對於hidden argument的依賴(比如環境變數等等)

特殊的Function:

  • infix function:(或可以稱為binary operator)
    • 函數出現在兩個參數之間,像是%%, %*%, %/%, %in%, %o%, %x%.
    • 可以這樣來定義:

[ code language="r" ]

%g%

paste(left, right)

}

[/code ]

  • replacement function
    • 函數只接改變其參數的數值。
  • pure function
    • 沒有side effect,輸入跟輸入乾淨
  • function with side effect
    • 會直接改變環境中的設定library()、setwd()、 Sys.setenv()Sys.setlocale()plot()、write()、write.csv()saveRDS()、options()par()

 

何時是寫function的好時機呢?

這邊可以參考這本Executive Data Science  裡面的說法,當你開始寫個code來完成一件事情的時候,這時候就要仔細記錄使用場景,要第次用這個代碼來完成事情的時候,便可以考慮一下撰寫function,當第次依舊需要再做一樣的事情時,就可以規劃來把function包成packages。

 

撰寫function的基本流程

  1. 先定義好自己function要完成的事情
  2. 先用一連串的expression來做快速的prototype
  3. 將其包裝成function
  4. 進行重構(refactoring),盡量讓代碼完成最小單位的事情,過多的複雜會使代碼難以閱讀和管理
  5. 進行vectorize,盡量讓函數的輸入維持成單個數入,避免過度的使function的表現更好預測
  6. 設定default值

發表迴響

在下方填入你的資料或按右方圖示以社群網站登入:

WordPress.com 標誌

您的留言將使用 WordPress.com 帳號。 登出 /  變更 )

Google+ photo

您的留言將使用 Google+ 帳號。 登出 /  變更 )

Twitter picture

您的留言將使用 Twitter 帳號。 登出 /  變更 )

Facebook照片

您的留言將使用 Facebook 帳號。 登出 /  變更 )

w

連結到 %s