LoginSignup
21
29

More than 3 years have passed since last update.

@zakkiiii(zakkiiii)

【RStudio】Gitに恋してバージョン管理 ～ 基礎篇 〜

Last updated at Posted at 2020-01-16

1. 趣旨

最近になって、Rのスクリプトやプロジェクトの管理をGitで始めました。

いや～～～～～非常に便利。
僕の中ではイノベーション。
これはスクリプト書くのが楽しくなる。

ということで、「Gitって何？食べられるの？」という過去の僕に向けた超入門。
GitとRStudioとの連携については、意外と超初心者向けのサイトが少なかったので、需要あるといいなぁ～～～。

留意点

  • この記事は、RStudioでプロジェクト管理を行うための超最低限のこと しか書いてません。Python等その他の環境での利用については全く考慮していません。
  • 肌感覚での理解で書いてます。厳密・正確な文言や使用法ではないかもです。
  • この記事は 僕のようなマジの初心者向け なので、Gitがある程度分かるという人は、この記事よりもコチラの記事のほうが参考になります。
    RStudioではじめるGitによるバージョン管理 - Qiita

環境

  • Windows 10 x64
  • R 3.6.2
  • RStudio 1.2.1335

2. Git × RStudioでできること

多分この記事を開いてる時点で、多少Gitやプロジェクト管理に興味がある状態のはずですが、改めて。
RStudioとGitを連携させて何ができるかと問われれば、 ずばり！バージョン管理です。具体的には、こんなことができます。

  • スクリプトの変更履歴の保存
  • プロジェクトのバックアップ・復元
  • パソコン間（ノート・デスクトップ）でのプロジェクトの同期

ね？なかなか魅力的でしょ？ かくいう僕も院生フレンズに教えてもらったのですが、慣れるとプロジェクト全体のバックアップにもなるし、スクリプトを書くのがすごーく楽しくなる。

しかーし！ 「Gitって何だ？」という僕にとっては中々難しく、用語も沢山出てくるので、最初は全く訳のわからないままブランチ（ほらね出てきたよ、、、）を大量に切ってしまったり、いつの間にかmaster（まーた知らないコトバが出てきたよ、、、）が消えたり、それはもう散々な目に遭いました。

「愚者は経験に学び、賢者は歴史に学ぶ」なんて言いますが、愚者たる僕の経験を歴史として笑って、皆さんは賢者になってください。

Git導入前のぼく

今まではスクリプトを書き直すたびにファイル名を変更してバックアップを取ってましたが、こんな問題点がありました。

  • どれが最終版？
  • 他人が作成したコードって自分のに反映したっけ？
  • このファイル、消して良いのか？
  • そもそも何を修正したんだっけ？
  • 前のバージョンに戻りたいんだけど、バックアップしてない・・・。

こういう問題が発生すると、僕の研究へのモチベーションが一気に下がるので、どうしてもモチベーションの維持のためにラーメン二郎を食い、結果として財布は痩せて身体は太ります。
スクリプトの管理もできない奴が、モチベーションと身体と金銭まで管理できるわけがない。

Git導入後のぼく

sugee.PNG

どうですよ。このデキるオトコ感。

  • 最終版がどれか分かる。
  • 変更の概要をメモできる。
  • 変更者・日付などは自動で記録される。
  • スクリプトのどこに変更が加えられたかという変更履歴が一目でわかる。
  • コードの修正等を別プロジェクトとして管理し、反映させることができる。
    それを視覚的にも把握できる。
  • いちいちファイル名を変更していくつもファイル作ったり消したりして管理する必要もない。
  • 必要であれば、過去のバージョンに遡れる。
  • スタバで開くとカッコいい。（検証済）
  • モテる。（要検証）

さあ、僕と一緒にGitを習得する気になりましたか？

3. Gitとは何なのか

Git自体については僕が説明するより、とても分かりやすい説明を引用させていただきます。

Gitはテキストファイルなどのバージョン管理を行うためのソフトウェアであるとよく言われます。バージョン管理は、ファイルの変更内容や変更履歴を保持しておいて、あとから古い状態に切り戻したりできるようにするためのものです。
つまり、「あぁ……この文章、変える前の方が良かったなぁ……前の状態に戻したいなぁ……」となった時に、前の状態まで（変更がコミットされていれば）復元できるようにするためのものです。
- 君には1時間でGitについて知ってもらう(with VSCode) - Qiita

Git自体はRやRStudio専用というわけではなく、むしろプログラミング全般で使われる管理ソフトです。
もっと活用すると共同作業の管理なども可能ですが、今回はわかりやすさ重視のため想定利用者は自分自身だけとします。

あと細かい説明は省きますが、GitとGitHubは別モノです！
連動させることも出来ますが、設定しない限りは関係ないです。

4. Gitのインストール

こちらからダウンロード。
https://git-scm.com/

基本的に指示に従っておけばOKです。
途中、PATHに関するオプションを聞かれますので、真ん中のUse Git from the Windows Command Promptを選択してください。
git-install06.png
画像：https://zero-config.com/windows/install-git-win-001.html より拝借。

何かオプションなどで困ったら、こちらを参考にしてみてください。
【初心者向け】Gitのインストール方法をわかり易く解説（画面付き）

ユーザー情報の登録

! ATTENTION !
この作業は省略できません！必ずやっておいてください！
省略してしまうと、ファイルのバージョン管理ができません！

インストールが完了したら、コマンドプロンプトを起動 して、次のように入力してください。
これらの情報はネット上ではなくローカルに保存されるので、GitとGitHub等と連動させない限りユーザー名もメアドも公開されないので安心してください。

ユーザー名は本名以外でもOKです。

git config --global user.name "ユーザー名"
git config --global user.email メールアドレス

なお、後々GitHub等との連携を考えている場合は、ユーザー名については公開されることがある点に留意してください。
メアドについては、公開 / 非公開の選択が可能ですが、デフォルトでは公開されます。
どうしても気になる方は、捨てアドを作って登録するという選択肢もあります。

また、GitHubと連動させていることが前提ですが、メアドの非公開化については、以下を参考にしてください。
GitHubのメールアドレスを非公開に設定する - kina's tech memo

これで準備OKです。

5. RStudioと連携させよう

さあ、インストールとユーザー情報の登録が完了したらRStudioとGitを繋げましょう！
初めての方は理解のために、まずは新規プロジェクトのパターンから始めることをおすすめします。

新規プロジェクトの場合

File > New Pojectで新規プロジェクトを作成します。

一番上のNew Directoryを押すとProject Typeを聞かれるので、New Projectを選択します。

Directory nameには管理するディレクトリの名前を入力し、その親ディレクトリ（作業フォルダをどこに作成するか）を選択します。好きなように入力・選択してください。
そして、Create a git repositoryのチェックを忘れずに！

Create Projectを押して、黄色い丸のようになってればOKです！

complete.PNG

6. 「Commit」＝変更を記録する

何でもいいので、スクリプトを作成して保存しましょう。
何でもいいと言われちゃうと困っちゃう可愛い子には、スーを差し上げます雑なコードを差し上げます。

iris.R
plot(iris$Petal.Length, iris$Petal.Width)
result <- lm(Sepal.Length ~ Sepal.Width, data = iris)
summary(result)

保存まで終わったら、右上のGitタブを開いてみましょう。こんな風になっていると思います。
5.PNG

この二つ並んだ？のアイコンはStatusと言います。左側がGitの状態、右側がディレクトリの状態を表します。
？アイコンが2つ並んでいると、そのファイルがGitによる管理の対象になっていないことを意味します。
なので、Gitに「このファイルの変更を追ってください！」とお願いしましょう。

GitでいうCommitとは、簡単に言うと、Gitにファイルの変更を記録すること をいいます。
近くにCommitというボタンがあるので押してみましょう。Review Changesウィンドウが立ち上がります。

キャプチャ.PNG
こんな画面が出てきたら、Stagedにチェックを入れましょう。
すると、先ほどまで？？だったアイコンがAになりました。
AはAddedの略で、変更の追跡対象を追加することを意味します。

右上のCommit messageには、変更の記録の概要などをメモできます。
とりあえず何でもいいので書いておきましょう。日本語もOKです。

ここまで出来たら、Commitボタンを押しましょう。
コマンドプロンプトっぽいのを閉じると、先ほどまで左上にあったファイルたちが消えていれば完了です。

※Statusのアイコンの詳細な意味はコチラを参照してください。

スクリプトを書き換えて変更を記録してみる

先ほど作成・保存したスクリプトを、何でもいいので一部を適当に変えて上書き保存してみてください。
僕の作った例の雑コードは、線形回帰の関数lm()の説明変数と目的変数を入れ替えてみました。

iris.R
plot(iris$Petal.Length, iris$Petal.Width)
result <- lm(Sepal.Width ~ Sepal.Length, data = iris)
summary(result)

上書き保存すると、Statusの右側（ディレクトリ側）にMアイコンが灯りました。MはModifiedの略、つまり変更が加えられたということを意味します。
6.PNG

では、この変更をGitに記録させましょう。
先ほどのようにCommitを押してReview Changesウィンドウを開いてみましょう。
Review Changesウィンドウでは、どこに変更が加えられたか、一発でわかるようになっています。赤色が変更前、緑色が変更後です。

そして同じように、チェックを入れて変更の概要を記述します。
チェックを入れると、Mが右から左に移るのが確認できると思います。これは、「Commitする（変更を記録する）とGit側で管理しているファイルをModified（変更）しますよー」ということを意味します。チェックを入れただけの段階ではまだGit側には変更は記録されず、Commitボタンを押すことで初めて変更がGit側に記録されます。

ちなみに、さっきからチェックを入れているStagedとは、対象を変更の記録をGitに反映させることを意味します。「まだこのファイルの変更はGitに記録したくないんだよなー」というときは、チェックを入れなければ記録されません。チェックしたファイルの変更だけがGitに反映されます。

ではでは、押してみましょう。
先ほどのようにファイル欄がクリアになったら成功です。

7. 変更履歴を確認したい

  • いつ、どのような変更を加えたか
  • 過去のバージョンを見たい・保存したい

などを知るために、Historyを確認しましょう。
先ほど開いていたReview Changesウィンドウの左上にあるHistoryをクリックするか、RStudioのGitタブにある時計マークをクリックします。
8.PNG
7.PNG

Historyでは、

  • ファイルの過去バージョンの参照
  • 変更履歴のメタデータ（日付・作成者など）の確認
  • Commit messageの閲覧
  • 前バージョンからの変更点の確認

などが出来ます。

ウィンドウの下半分には、選択したバージョンの、ひとつ前のバージョンからの変更点が記載されます。前バージョンから変更点がない場合は載らないので留意してください。

9.PNG

もしファイル数が膨大だったり内容の変更が多い場合など、スクロールして探すのが面倒な場合は、見たいファイルをクリックするとジャンプできます。iris.Rの変更点が見たい場合は、下の画像の赤丸部分をクリックです。
13.png

8. バージョンを戻してみよう

バージョン戻しはざっくり以下の2つあります。

  • Commitを押しちゃったけど、それ以前の作業履歴まで遡りたい場合。
  • まだCommitを押してなくて、作業前の状態（直近のCommitを押した時点）まで遡りたい場合。

直近のCommitより過去まで遡りたい場合

Commitを押しちゃったけど、やっぱりCommit押す前のほうが良かった！という場合、Gitを使ってると簡単に過去のバージョンに参照できます。

戻し方は色々ありますが、ここは一番ベーシックなやり方でやってみましょう。
今回は、スクリプトファイル（iris.R）をinitial commit（最初のコミット時点）まで復元しましょう。

1. Historyで戻したいポイントを参照する

今回はinitial commitまで遡るので、その時点の履歴を参照しましょう。

10.PNG

2. 戻したいファイルのView fileをクリック

下の画像のように、過去のバージョンを閲覧できるリンクがあるのでクリックして開きましょう。

12.PNG

すると、過去の状態のものが表示されます。これを上書き保存しましょう。

14.PNG

RStudioに戻ると、スクリプトに変更が加わったことによるMが表示されたことを確認できます。あとは、これを再度Commitさせれば完了です。

15.PNG

Commit押す前で、直近まで遡りたい場合

例えば、今日の作業、失敗だったなーーー。今日の作業はなかったことにしたいなーーー。という場合。
かつ、まだ失敗した作業内容をGitに記録させてない（Commitを押していない）場合。

この場合は、とても簡単で手軽です。
先ほどのスクリプトを、今度はこうしてみましょう。書いたら ファイルは上書き保存しますが、Commitはしないでください。右列にMと表示されていればOKです。

iris.R
plot(iris$Petal.Length, iris$Petal.Width)
result <- lm(Sepal.Length ~ Sepal.Width, data = iris)
summary(result)
# いらないメモ

この# いらないメモを書く前の状態に戻したい場合、つまり、以下のような直近でCommitした時点のバージョンに戻したいということです。

iris.R
plot(iris$Petal.Length, iris$Petal.Width)
result <- lm(Sepal.Length ~ Sepal.Width, data = iris)
summary(result)

例のごとく、Review Changesウィンドウを開きましょう。

今回はCommitではなくRevertというボタンを押してみると、「選択したファイルの変更が失われるけどいい？（超意訳）」とお尋ねが来るので、元気よくYesを押しましょう。

16.PNG

するとあら不思議。元通りに戻りましたとさ。めでたし。

17.PNG

9. まとめ

ここまでが僕的エッセンスです。

とりあえず一人で作業をする分にはここまででも十分かなーーーと思います。
これ以降はQiitaで検索するかググればなんとかなるかも。
活用しよう、集合知。

とりあえずブランチとかプルとかブッシュとか、そういう概念を知らなくても、RStudio上でプロジェクト管理ができましたね。
かくいう僕は、GitHubとも同期させて、自宅のデスクトップとノートPCで変更を共有させてます。
そういう使い方まで書きたかったのですが、それは機会があればまた書きます。

Enjoy!

おしまい。

今後追加したいコンテンツ

余力があれば、今後この辺のコンテンツを追加したいと思います。
別記事にするかもしれません。

  • 既存のRプロジェクトをGitで管理する
  • ブランチとは何ぞ
  • GitHubとの連携
  • Push・Pullとは何ぞ

なお、この辺について知りたい方は、他の方の記事にあると思いますので、是非調べてみてください。

10. 参考文献

21
29
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
21
29