-
Notifications
You must be signed in to change notification settings - Fork 2
/
Packrat.Rmd
213 lines (117 loc) · 5.49 KB
/
Packrat.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
---
title: "Packrat"
author: "Mitch and Travis"
date: "April 10, 2015"
output: html_document
---
========================================================
## Why Use Packrat?
- Isolation
- Portability
- Reproducibility
- Have you ever had to use trial-and-error to figure out what R packages you need to install to make someone else’s code work and then been left with those packages globally installed forever???
- Have you ever updated a package to get code in one of your projects to work, only to find that the updated package makes code in another project stop working???
========================================================
## How it works
- Packrat stores your package dependencies inside your project directory
rather than in your personal R library
- This directory is known as your **private library**
- When you start an R session in a packrat project directory, R will only
look for packages in your private library
- if you install or remove a package, those changes are only made to your
private library
### **Restoring:** the process of istalling packages to private libraries from a snapshot
- Private libraries don't usually travel well since the contents are compiled for your specific computer, OS, and R version
- Packrat takes a **snapshot** of your private library, which it saves to your project directory
- From this, Packrat can re-create the same private library on another computer
Installing Packrat
========================================================
> install.packages("packrat")
Set-up
========================================================
set up the project directory to use Packrat
> packrat::init:
- do this first thing before typing any other code
- include a path after init if you are not in your working directory
+ ex. packrat::init("~/projects/pollinatordata")
If you have R-studio (v. 0.98.945 or newer), you can simply check the box!
## Congratulations! You have achieved isolation
-----------
- You’re no longer in an ordinary R project; you’re in a Packrat project.
- You now have your own private package library
- Any packages you install from inside a packrat project are only available to that project
- Any packages you install outside of the project are not available to the project
What is a library?
=============================
to see what's in your library
> library()
library = directory where packages are stored
Packrat makes a private library for you and helps you to keep it clean and organized
Installing Packages in your Private Library
========================================================
> install.packages("reshape2")
> install.packages("stringr")
> install.packages("ggplot2")
- install a package the way you normally would
Taking a Snapshot of your Private Library
========================================================
> packrat::snapshot()
Restoring Snapshots
========================================================
### If you want to run your project on a different computer
- After copying a project to a new computer, simply launch R from your project directory
- Packrat automates the whole process
- All of the packages in the snapshot will be installed in your project’s private package library.
Check Status
========================================================
> packrat::status()
Restoring Snapshots
========================================================
If you delete a package that you realize later you need or if a collaborator makes a change to a snapshot
> packrat::restore()
Cleaning Up
========================================================
- Packrat analyzes your code to determine if there are packages that were maybe needed at one time but are no
longer used
- You can then tell Packrat to remove these functions
- check the status
> packrat::status()
- Packrat will tell you which packages are installed but not needed
- Remove these unneeded packages
> packrat::clean()
Demonstration
========================================================
Now we will go through a brief interactive demonstration with Packrat
**Install Packrat**
> install.packages("packrat")
**Put Packrat in your Library**
>library(packrat)
**Install a few packages for this demonstration**
> install.packages("reshape2")
> install.packages("stringr")
> install.packages("ggplot2")
**Take a snapshot of your current private library**
> packrat::snapshot()
**Check the status of your private library**
> packrat::status()
all should be up-to-date
**Remove a Package**
> remove.packages("reshape2")
**Check status again**
> packrat::status()
Packrat should now tell you that there was a package removed
**You can then bring back the removed package**
> packrat::restore()
**Re-check the status**
> packrat::status()
**To get rid of packages you are no longer using**
> packrat::clean()
**To bring those packages back**
> packrat::restore()