-
Notifications
You must be signed in to change notification settings - Fork 1
/
uninstall.html
249 lines (194 loc) · 11.8 KB
/
uninstall.html
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ggd uninstall — GGD documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/style.css" />
<link rel="stylesheet" type="text/css" href="_static/font-awesome-4.7.0/css/font-awesome.min.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="ggd list" href="list.html" />
<link rel="prev" title="ggd predict-path" href="predict-path.html" />
<link href="https://fonts.googleapis.com/css?family=Lato|Raleway" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Inconsolata" rel="stylesheet">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="_static/ms-icon-144x144.png">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.12.6/css/selectize.bootstrap3.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.3.1/css/bootstrap.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/datatables/1.10.21/js/jquery.dataTables.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.12.6/js/standalone/selectize.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.3.1/js/bootstrap.bundle.min.js"></script>
</head><body>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="index.html">
<img class="logo" src="_static/logo/GoGetData_name_logo.png" alt="Logo"/>
</a>
</p>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick-start.html">GGD Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-ggd.html">Using GGD</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="GGD-CLI.html">GGD Commands</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="ggd-search.html">ggd search</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html">ggd install</a></li>
<li class="toctree-l2"><a class="reference internal" href="predict-path.html">ggd predict-path</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">ggd uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="list.html">ggd list</a></li>
<li class="toctree-l2"><a class="reference internal" href="list-file.html">ggd get-files</a></li>
<li class="toctree-l2"><a class="reference internal" href="pkg-info.html">ggd pkg-info</a></li>
<li class="toctree-l2"><a class="reference internal" href="show-env.html">ggd show-env</a></li>
<li class="toctree-l2"><a class="reference internal" href="make-recipe.html">ggd make-recipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="make-metarecipe.html">ggd make-meta-recipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="check-recipe.html">ggd check-recipe</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="meta-recipes.html">GGD meta-recipes</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="private_recipes.html">Private Recipes</a></li>
<li class="toctree-l1"><a class="reference internal" href="workflows.html">Using GGD in Workflows</a></li>
<li class="toctree-l1"><a class="reference internal" href="recipes.html">Available Data Packages</a></li>
</ul>
<ul>
<li class="toctree-l1"><a href="https://github.com/gogetdata/ggd-recipes">ggd-recipes @ Github</a></li>
<li class="toctree-l1"><a href="https://github.com/gogetdata/ggd-cli">ggd-cli @ Github</a></li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="ggd-uninstall">
<span id="id1"></span><h1>ggd uninstall<a class="headerlink" href="#ggd-uninstall" title="Permalink to this headline">¶</a></h1>
<p>[<a class="reference internal" href="index.html#home-page"><span class="std std-ref">Click here to return to the home page</span></a>]</p>
<p><code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">uninstall</span></code> is used to uninstall ggd package(s) from your local conda environment that has been installed by
ggd. It ensures a correct uninstall of the data package along with removal of additional files created during installation.</p>
<blockquote>
<div><div class="admonition note">
<p class="admonition-title">Note</p>
<p>Running <code class="code docutils literal notranslate"><span class="pre">conda</span> <span class="pre">uninstall</span> <span class="pre"><package></span></code> will work, however, it will only uninstall the package and will not
provide file and system management. <strong>Please use</strong> <code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">uninstall</span> <span class="pre"><package></span></code> <strong>when uninstalling a ggd data package</strong>.</p>
</div>
</div></blockquote>
<div class="section" id="using-ggd-uninstall">
<h2>Using ggd uninstall<a class="headerlink" href="#using-ggd-uninstall" title="Permalink to this headline">¶</a></h2>
<p>Use <code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">uninstall</span></code> to uninstall a ggd data package previously installed using <code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">install</span></code>.
Running <code class="code docutils literal notranslate"><span class="pre">ggd</span> <span class="pre">uninstall</span> <span class="pre">-h</span></code> will give you the following message:</p>
<p>Uninstall arguments:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 22%" />
<col style="width: 78%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>ggd uninstall</p></th>
<th class="head"><p>Use ggd to uninstall a ggd data package installed in the current conda
environment</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">-h</span></code>, <code class="docutils literal notranslate"><span class="pre">--help</span></code></p></td>
<td><p>show this help message and exit</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">names</span></code></p></td>
<td><p>the name(s) of the ggd package(s) to uninstall</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">-c</span></code>, <code class="docutils literal notranslate"><span class="pre">--channel</span></code></p></td>
<td><p>(Optional) The ggd channel the desired recipe is stored in.(Default = genomics)</p></td>
</tr>
</tbody>
</table>
<div class="section" id="additional-argument-explanation">
<h3>Additional argument explanation:<a class="headerlink" href="#additional-argument-explanation" title="Permalink to this headline">¶</a></h3>
<p>Required arguments:</p>
<ul class="simple">
<li><p><em>names:</em> The <code class="code docutils literal notranslate"><span class="pre">names</span></code> is the name or names of the ggd data package(s) to uninstall.</p></li>
</ul>
<p>Optional arguments:</p>
<ul>
<li><p><em>-c:</em> The <code class="code docutils literal notranslate"><span class="pre">-c</span></code> flag represents the ggd channel. The default channel is <em>genomics</em>. If the data package you want to uninstall
is in a different ggd channel you will need to supply the channel name using this flag.</p>
<blockquote>
<div><div class="admonition note">
<p class="admonition-title">Note</p>
<p>You need to be in the conda environment/prefix in which the data has been installed in order to uninstall it.
If the data packages you are trying to uninstall is not in the current/active conda environment it will not be
uninstalled, or it will uninstall the package that is in that environment which would not be the intent.</p>
</div>
</div></blockquote>
</li>
</ul>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<div class="section" id="failed-uninstall-example">
<h3>1. Failed uninstall example:<a class="headerlink" href="#failed-uninstall-example" title="Permalink to this headline">¶</a></h3>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ ggd uninstall hg19-ga
:ggd:uninstall: Checking <span class="k">for</span> installation of hg19-ga
:ggd:uninstall: hg19-ga is not in the ggd-genomics channel
:ggd:uninstall: Unable to find any package similar to the package entered. Use <span class="s1">'ggd search'</span> or <span class="s1">'conda find'</span> to identify the right package
:ggd:uninstall: This package may not be installed on your system
</pre></div>
</div>
</div>
<div class="section" id="successful-uninstall-example">
<h3>2. Successful uninstall example:<a class="headerlink" href="#successful-uninstall-example" title="Permalink to this headline">¶</a></h3>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ ggd uninstall hg19-gaps-ucsc-v1
:ggd:uninstall: Checking <span class="k">for</span> installation of hg19-gaps-ucsc-v1
:ggd:uninstall: hg19-gaps-ucsc-v1 is installed by conda on your system
:ggd:uninstall: Uninstalling hg19-gaps-ucsc-v1
Collecting package metadata <span class="o">(</span>repodata.json<span class="o">)</span>: <span class="k">done</span>
Solving environment: <span class="k">done</span>
<span class="c1">## Package Plan ##</span>
environment location: <env>
removed specs:
- hg19-gaps-ucsc-v1
The following packages will be REMOVED:
hg19-gaps-ucsc-v1-1-1
Preparing transaction: <span class="k">done</span>
Verifying transaction: <span class="k">done</span>
Executing transaction: <span class="k">done</span>
:ggd:uninstall: Removing hg19-gaps-ucsc-v1 version <span class="m">1</span> file<span class="o">(</span>s<span class="o">)</span> from ggd recipe storage
:ggd:uninstall: Deleting <span class="m">9</span> items of hg19-gaps-ucsc-v1 version <span class="m">1</span> from your conda root
:ggd:env: Removing the ggd_hg19_gaps_ucsc_v1_dir environment variable
:ggd:env: Removing the ggd_hg19_gaps_ucsc_v1_file environment variable
:ggd:uninstall: Updating installed package list
:ggd:uninstall: DONE
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016-2021, The GoGetData team.
|
<a href="_sources/uninstall.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>