GitHub と RStudio を使う

2018年2月10日 // 3 min read

image

本チュートリアルでは、RStudio で R Markdown ドキュメントを作成し、GitHub Pages を使って GitHub 経由で公開する方法について学びます。

RStudio は R の統合開発環境として人気があり、R で使用するツールを単一の環境に統合します。GitHub Pages を使えば、GitHub リポジトリから直接ウェブサイトをホストできます。

本チュートリアルでは以下の方法を学びます。

  • 新しいリポジトリを作成する。
  • ローカル マシンで Git と RStudio を使ってリポジトリを操作する。
  • GitHub.com ウェブサイトまたは GitHub Enterprise を使って GitHub ワークフローを完了させる。
  • GitHub Pages を使って R Markdown ドキュメントを公開、共有する。

前提条件

  • 本チュートリアルでは GitHub.com または GitHub Enterprise のアカウントが必要です。
  • Git、GitHub、GitHub Pages の初心者の方は、まず「GitHub Pages from the command-line (GitHub Page をコマンドラインから操作する)」コースを修了することをお勧めします。
  • R を使ったプログラミングの知識があると役立ちますが、必須ではありません。

Git と RStudio をインストールする

本チュートリアルでは、Git と RStudio を使って GitHub リポジトリを操作します。

  1. Git をダウンロードしてインストールします。
  2. RStudio (1.1.383 以降) をダウンロードしてインストールします。
  3. RStudio を開きます。

GitHub にリモート リポジトリを作成する

ローカルに必要なものがインストールできたところで、新しいウェブサイトを格納するリポジトリを作成しましょう。

  1. GitHub.com で新しいリポジトリを作成します。

注: 組織が GitHub Enterprise を使っている場合は、そこにリポジトリを作成することもできます。

  1. リポジトリ名を cars に設定します。別の名前でもかまいません。
  2. リポジトリの説明を入力します。
  3. [Public ] (パブリック) の可視性を選択します。
  4. README でこのリポジトリを初期化する設定を選択します。
  5. .ignore を追加する設定をクリックし、R を選択します。
  6. [Create repository ] (リポジトリを作成) をクリックします。

RStudio でリポジトリのクローンを作成する

GitHub (リモートリポジトリ) にリポジトリを作成したら、次はそのリポジトリのクローンをローカル環境に作成します。

  1. GitHub でリポジトリの [Code] (コード) タブに移動します。
  2. 画面右側の Clone or download (クローンまたはダウンロード) をクリックします。
  3. リポジトリの URL の右にある Copy to clipboard (クリップボードにコピー) アイコンをクリックします。
  4. ローカル環境で RStudio を開きます。
  5. File (ファイル) > New Project (新規プロジェクト) > Version Control (バージョン管理) > Git の順にクリックします。
  6. リポジトリの URL を貼り付け、TAB キーを押して Project directory name (プロジェクトのディレクトリ名) フィールドに移動します。
  7. Create Project (プロジェクトを作成) をクリックします。

RStudio で R Markdown ドキュメントを作成する

リポジトリのローカル コピーができたところで、プロジェクトに R Markdown ドキュメントを追加してみましょう。

  1. RStudio で File (ファイル) > New File (新規ファイル) > R Markdown の順にクリックします。
  2. デフォルトの出力として HTML 出力を選択します。
  3. File (ファイル) > Save (保存) の順にクリックし、ドキュメントを保存します。
  4. speed-and-distance と入力し、Save (保存) をクリックします。 rstudio-editor

変更をコミットして GitHub にプッシュする

R Markdown ドキュメントを作成して変更を終えたら、ドキュメントをコミットします。

  1. RStudio で右上のペインの Git タブをクリックします。
  2. Commit をクリックします。
  3. Review changes (変更を確認) ビューで、ステージングに関するチェックボックスを全てのファイルでオンにします。
  4. コミットメッセージを追加します (例: Add initial speed and distance report (初速と距離のレポートを追加))。
  5. Commit をクリックします。
  6. Pull (プル) ボタンをクリックして、リモートの変更を取得します。
  7. Push (プッシュ) ボタンをクリックして、変更をリモート リポジトリにプッシュします。
  8. GitHub でリポジトリの [Code] (コード) タブに移動し、変更を確認します。

Git でローカル ブランチを作成する

GitHub フローの手順で、プロジェクトにもう少し変更を加えてみましょう。現在、RStudio ではローカルブランチがあまりサポートされていないため、RStudio のコマンドラインから Git を使います。

  1. RStudio の左下のペインの Terminal (ターミナル) タブをクリックします。ターミナル タブはコンソール タブの隣にあります。rstudio-terminal

注: ターミナル タブが見つからない場合は、RStudio のバージョンが 1.1.383 以降かどうかを確認してください。Help (ヘルプ) > About RStudio (RStudio について) の順にクリックすると、現在のバージョンを確認できます。

  1. 新しいブランチを作成します。<BRANCH-NAME> を説明的な名前を置き換えます。例は以下のとおりです。speed-and-distance-report:

    git branch <BRANCH-NAME>

  2. リポジトリのステータスを確認します。

    git status

    新しいブランチを作成したにもかかわらず、master ブランチにチェックアウトされていることがわかります。このことは Git からのインライン応答でも示されています。

  3. 新しいブランチにチェックアウトします。

    git checkout <BRANCH-NAME>

  4. 新しいブランチにチェックアウトしたことを確認します。

    git status

Git でローカルに変更を加える

HTML 出力を docs という別のディレクトリに生成してみましょう。これを行うには、R Markdown ドキュメントの見出しに関数を追加して、任意の出力ディレクトリに出力を「knit」します。

  1. RStudio で speed-and-distance.Rmd を開き、title フィールドの下の見出しに以下の行を追加します。
 knit: (function(input_file, encoding) {
    out_dir <- 'docs';
    rmarkdown::render(input_file,
      encoding=encoding,
      output_file=file.path(dirname(input_file), out_dir, 'index.html'))})
  1. File (ファイル) > Save (保存) の順にクリックし、変更を保存します。
  2. speed-and-distance.Rmd のドキュメント ペインで Knit をクリックします。

Git でローカルの変更をコミットする

HTML 出力を作成したら、変更をコミットします。

  1. ファイルのステータスを判断します。git status を使えば、ブランチ上のファイルのステータスをいつでも確認できます。ファイルは Untracked files (トラッキングされていないファイル) という見出しの下に表示されます。

    git status

  2. ファイルをステージング エリアに追加し、次のコミットの一部となるようにします。

    git add .

  3. ファイルの現在のステータスを確認します。ファイルは Changes to be committed (コミット予定の変更) という見出しの下に表示されています。これは、ファイルがステージング エリアにあることを示しています。また、このファイルが新しいファイルであることも示しています。

    git status

  4. ファイルをコミットします。<COMMIT-MESSAGE> を変更内容を示すログ メッセージに置き換えます (例: Knit output to a docs folder (出力をドキュメント フォルダに knit))。コミットは、ステージング エリアにある全てのファイルを集めてひとつの作業単位としてバージョン管理に保存するよう Git に指示します。

    git commit -m "<COMMIT-MESSAGE>"

  5. コミットの履歴を確認します。

    git log --oneline

  6. master ブランチと現在のブランチ (HEAD) の間の変更を確認します。

    git diff --stat --summary master..<BRANCH-NAME>

GitHub でプル リクエストをオープンする

ローカルでコミットを行ったところで、次は GitHub のリモート リポジトリに変更を送信してプル リクエストを作成しましょう。

  1. 変更をリモート リポジトリにプッシュします。

    git push -u origin <BRANCH-NAME>

  2. GitHub でプル リクエストを作成します。

  3. プル リクエストの本文に、変更についての情報を記入します。

GitHub でプル リクエストをマージする

これは個人のリポジトリであるため、おそらく (まだ) 共同作業する相手はいないはずです。そのままプル リクエストをマージします。

  1. GitHub で、先ほどオープンしたプル リクエストに移動します。
  2. 下にスクロールして、大きな緑色の Merge Pull Request (プル リクエストをマージ) ボタンをクリックします。
  3. [Confirm Merge] (マージを確定) をクリックします。
  4. ブランチ <BRANCH-NAME> を削除します。

Pages サイトを作成する

本チュートリアルでは、GitHub Pages を使って HTML 出力を公開します。GitHub Pages を初期化するには、さらに次のいくつかの手順を実行する必要があります。

  1. リポジトリで [Settings] (設定) タブをクリックします。
  2. [GitHub Pages] セクションまで下にスクロールします。
  3. Source (ソース) で、master branch /docs folder (master ブランチ /docs フォルダ) を選択します。 pages-configuration
  4. Save (保存) をクリックし、変更を保存します。
  5. 生成された GitHub Pages の URL をクリックして、レンダリングされた R Markdown ドキュメントを表示します。

注: GitHub Pages サイトは、GitHub.com でホストされている場合は常に公開されます。一部の人にサイトを共有する場合は、Jekyll Auth を利用できます。GitHub Enterprise では、プライベート モードが有効になっている場合、ユーザーは GitHub Pages サイトにアクセスするために認証が必要です。

ローカル リポジトリを更新する

プル リクエストをマージした後、リポジトリのローカル コピーを更新する必要があります。

  1. RStudio の [Terminal] (ターミナル) ペインで以下を入力します。

    git checkout master

  2. 以下を入力します。

    git pull

  3. ローカル ブランチを削除します。:

    git branch -D <BRANCH-NAME>

  4. コミットの履歴をグラフで確認します。

    git log --oneline --graph --all

RStudio でもコミットの履歴を表示できます。Git ペインの Commit (コミット) をクリックして [Review Changes] (変更を確認) パネルを開き、History (履歴) をクリックします。

トップ ページ、テーマ、ナビゲーションを追加する

R Markdown ドキュメントのコレクションを公開するためのトップ ページ、テーマ、ナビゲーションを追加しましょう。

  1. まず、新しいブランチを作成します。再度 <BRANCH-NAME> を 説明的な名前に変更します (例: add-theme-and-navbar)。

    git checkout -b <BRANCH-NAME>

  2. 以下の内容のファイル _site.yml を追加します。

 name: "cars"
 output_dir: "docs"
 navbar:
 title: "Cars"
 left:
 - text: "Home"
 href: index.html
 - text: "Speed and Distance"
 href: speed-and-distance.html
 output:
 html_document:
 theme: cosmo

  1. 新しい R Markdown ドキュメント index.Rmd を追加します。これがトップ ページです。

  2. speed-and-distance.Rmd を開き、見出しから knit と output フィールドを削除します。これで見出しは以下のようになります。

 ---
 title: "Speed and Distance"
 ---

  1. 変更を保存します。

  2. 左下のペインの Console (コンソール) を開き、以下のコマンドを使用してサイトをレンダリングします。

rmarkdown::render_site()
  1. ローカルの変更を Git でコミットします。
     git status
 git add .
 git commit -m "Add home page, navigation and theme"

プル リクエストをオープンする

トップ ページとナビゲーションを追加したところで、GitHub リポジトリのリモート コピーに変更を送信して新しいプル リクエストをオープンします。

  1. 変更をリモート リポジトリにプッシュします。

    git push -u origin <BRANCH-NAME>

  2. GitHub でプル リクエストをオープンします。

  3. プル リクエストをマージします。

  4. 更新したサイトを表示します。サイトは以下の画像のように表示されるはずです。

    speed-and-distance

  5. GitHub Pages の URL をリポジトリの説明に追加して、見つけやすくします。

GitHub Pages の URL を思い出せない場合は、設定ページの [GitHub Pages] セクションにある URL からいつでも確認できます。

お疲れ様でした! 🎉

RStudio を使った GitHub ワークフローが完了し、レンダリングした R Markdown ドキュメントを公開するための GitHub Pages サイトがプロジェクトに追加されました。

リンク

  • R Markdown ウェブサイトの R Markdown ウェブサイト 記事は、R Markdown ドキュメントのコレクションをホストする GitHub Pages ウェブサイトを構築するのに便利なリソースです。
  • RStudio でブランチを操作する際、ターミナルで Git コマンドを入力するおではなくグラフィカル ユーザー インターフェイスを使用する場合は、GitHub Desktop を使用してください。

Tags

GitHub をビジネスに役立てる方法をお探しですか?

お客様のニーズをお聞かせください