github & R package

  • この記事はとても良いです(Japanese only)
  • Rパッケージの良さはインストールが簡単でヘルプ記事が必ずついていること One of R's strong points is that installing packages is easy and every package has its help article.
  • その良さはパッケージ作成の側に回ると苦役になる The strong point turns into a labor when you make a package yourself.
  • Githubからインストール可能であれば、ヘルプとかはなくてもよし、という条件で、devtoolsパッケージのinstall_github()関数によって共有できる。そんな低レベルを最低ラインとした、「なんちゃってRパッケージ」を作るとすると、どうするか… Let's make an unofficial package with which you can share your own functions with others but you don't have to make perfect help articles for them, that should be placed in your github account and can be installed by install_github() function in devtools package.
  • 必要なもの Necessary items
    • Githubアカウント Get your own github account.
    • gitコマンドが打てること Get ready to use git command in your environment.
    • Rのdevtoolsパッケージのインストール Install devtools package inR.
    • コンパイラ関係(WindowsならRtools) Get compilers (e.g Rtools ready in case of Windows environment)
  • 共有・公開にも色々なレベルがある There are various ways to open your functions.
    • 関数構成 Regarding types of your functions:
      • R関数のみ R functions only
      • C,C++,Fortranも使う Includes C, C++, and/or fortran
      • Rcppを使う Include Rcpp-based function
    • ヘルプ記事の親切さ Regarding help articles.
      • ヘルプ記事、一切なし No help articles.
      • ヘルプ記事があって、関数のリストが見られるけれど、関数ごとの情報は不備(関数コード自体を読めば良しとする) List of functions are available but no help article for each function.
      • ヘルプ記事をそれなりにきちんと書く Help articles for pertinent R functions.
      • 完璧なヘルプ記事をつける Perfect help articles.