-
Notifications
You must be signed in to change notification settings - Fork 1
/
contribute.html
198 lines (164 loc) · 10.4 KB
/
contribute.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contribute — 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="Setting up with Github" href="github-setup.html" />
<link rel="prev" title="GGD meta-recipes" href="meta-recipes.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"><a class="reference internal" href="GGD-CLI.html">GGD Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="meta-recipes.html">GGD meta-recipes</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="github-setup.html">Setting up with Github</a></li>
<li class="toctree-l2"><a class="reference internal" href="contribute-recipe.html">Contributing a ggd recipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="making-meta-recipes.html">Creating a ggd meta-recipe</a></li>
</ul>
</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="contribute">
<span id="make-data-packages"></span><h1>Contribute<a class="headerlink" href="#contribute" 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><strong>To see and/or search for data packages available through GGD, see:</strong> <a class="reference internal" href="recipes.html#recipes"><span class="std std-ref">Available data packages</span></a></p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>If you use GGD, please cite the <a class="reference external" href="https://www.nature.com/articles/s41467-021-22381-z">Nature Communications GGD paper</a></p>
</div>
<p>Similar to <strong>Conda</strong> and <strong>Bioconda</strong>, ggd encourages and relies on community contributions. Our vision is that
ggd will become a widely used data management system in genomics and other research fields. ggd will help reduce
the time it takes to find, extract, and process the necessary data for any analysis and support research
reproducibility/replicability. Similar to the use of conda for package management, and Bioconda for biological software
package management, ggd will become a common tool for accessing the required data for your research needs.</p>
<p>With the contributions and maintenance of data recipes from the research community, ggd will become a common
tool for using scientific data. ggd will empower scientists to perform and analyze research data quicker and
more accurately, providing a steady tool for scholarly advancement.</p>
<p>We invite everyone to contribute data recipes to ggd, and thus providing access to scientific data for
scientists around the world.</p>
<p>The ggd tool has been developed to help with contributing data recipes to ggd and a few functions are
provided to make this process easy. Outlined below is the steps that should be followed to create data
recipe and add it to the ggd data repository.</p>
<ol class="arabic">
<li><p><a class="reference internal" href="github-setup.html#setup-github"><span class="std std-ref">Github</span></a></p>
<blockquote>
<div><ul class="simple">
<li><p>You will need a github account and a forked repository of ggd-recipes.</p></li>
<li><p>Once you have a github account and you have a forked ggd-recipes repo, you do not need to do step 1 again.</p></li>
</ul>
</div></blockquote>
</li>
</ol>
<p>2a. <a class="reference internal" href="contribute-recipe.html#contrib-recipe"><span class="std std-ref">Make a ggd recipe</span></a></p>
<blockquote>
<div><ul class="simple">
<li><p>The following steps will outline how to create a ggd data recipe, how to test it, and how to add it to the
gogetdata/ggd-recipes repo.</p></li>
</ul>
</div></blockquote>
<p>2b. <a class="reference internal" href="making-meta-recipes.html#contribute-meta-recipe"><span class="std std-ref">Make a ggd meta-recipe</span></a></p>
<blockquote>
<div><ul class="simple">
<li><p>The following steps will outline how to create a ggd data meta-recipe, how to test it, and how to add it
to the gogetdata/ggd-recipe repo.</p></li>
</ul>
</div></blockquote>
<ol class="arabic" start="3">
<li><p>Continuous Integration testing with Circle CI</p>
<blockquote>
<div><ul class="simple">
<li><p>We use Circle CI to test all new recipes. Any recipe that passes will be officially added to the ggd repo
and will be available to anyone using the ggd install tool. If it does not pass, the ggd team will work
with you on getting it to pass.</p></li>
</ul>
</div></blockquote>
</li>
</ol>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="github-setup.html">Setting up with Github</a></li>
<li class="toctree-l1"><a class="reference internal" href="contribute-recipe.html">Contributing a ggd recipe</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contribute-recipe.html#update-local-forked-repo">1. Update local forked repo</a></li>
<li class="toctree-l2"><a class="reference internal" href="contribute-recipe.html#writing-a-bash-script-to-get-data">2. Writing a bash script to get data</a></li>
<li class="toctree-l2"><a class="reference internal" href="contribute-recipe.html#create-a-ggd-recipe-using-the-ggd-cli">3. Create a ggd recipe using the ggd cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="contribute-recipe.html#build-install-and-check-the-data-recipe">4. Build, install, and check the data recipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="contribute-recipe.html#submit-the-new-ggd-recipe-to-the-original-ggd-recipes-repo">5. Submit the new ggd recipe to the original ggd-recipes repo</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="making-meta-recipes.html">Creating a ggd meta-recipe</a><ul>
<li class="toctree-l2"><a class="reference internal" href="making-meta-recipes.html#update-local-forked-repo">1. Update local forked repo</a></li>
<li class="toctree-l2"><a class="reference internal" href="making-meta-recipes.html#writing-the-curation-script-s">2. Writing the curation script(s)</a></li>
<li class="toctree-l2"><a class="reference internal" href="making-meta-recipes.html#creating-a-ggd-meta-recipe-using-the-ggd-cli">3. Creating a ggd meta-recipe using the ggd cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="making-meta-recipes.html#checking-testing-the-new-meta-recipe">4. Checking/Testing the new meta-recipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="making-meta-recipes.html#submit-the-new-ggd-meta-recipe-to-the-original-ggd-recipes-repo">5. Submit the new ggd meta-recipe to the original ggd-recipes repo</a></li>
<li class="toctree-l2"><a class="reference internal" href="making-meta-recipes.html#example-of-the-gene-expression-omnibus-geo-main-bash-script-and-supporting-python-script">6. Example of the Gene Expression Omnibus (GEO) main bash script and supporting python script</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016-2021, The GoGetData team.
|
<a href="_sources/contribute.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>