Skip to content

Commit 09aea30

Browse files
committed
Add new recipes
Update doc info Ohter updates
1 parent 0854aae commit 09aea30

654 files changed

Lines changed: 10100 additions & 1694 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

GGD-CLI.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ <h3 id="searchlabel">Quick search</h3>
206206
</ul>
207207
</li>
208208
<li class="toctree-l1"><a class="reference internal" href="list-file.html">ggd get-files</a><ul>
209-
<li class="toctree-l2"><a class="reference internal" href="list-file.html#using-ggd-list-files">Using ggd list-files</a></li>
209+
<li class="toctree-l2"><a class="reference internal" href="list-file.html#using-ggd-get-files">Using ggd get-files</a></li>
210210
<li class="toctree-l2"><a class="reference internal" href="list-file.html#examples">Examples</a></li>
211211
</ul>
212212
</li>

_sources/check-recipe.rst.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ check-recipe arguments:
2727
| ggd check-recipe | Convert a ggd recipe created from `ggd make-recipe` into a data package. Test |
2828
| | both ggd data recipe and data package |
2929
+=======================+==================================================================================+
30-
| -h, --help | show this help message and exit |
30+
| ``-h``, ``--help`` | show this help message and exit |
3131
+-----------------------+----------------------------------------------------------------------------------+
32-
| -d, --debug | (Optional) Set the stdout log level to debug |
32+
| ``-d``, ``--debug`` | (Optional) Set the stdout log level to debug |
3333
+-----------------------+----------------------------------------------------------------------------------+
34-
| -du, --dont_uninstall | (Optional) By default the newly installed local ggd |
35-
| | data package is uninstalled after the check has |
36-
| | finished. To bypass this uninstall step (to keep the |
37-
| | local package installed) set this flag "-- |
38-
| | dont_uninstall" |
34+
| ``-du``, | (Optional) By default the newly installed local ggd |
35+
| ``--dont_uninstall`` | data package is uninstalled after the check has |
36+
| | finished. To bypass this uninstall step (to keep the |
37+
| | local package installed) set this flag "-- |
38+
| | dont_uninstall" |
3939
+-----------------------+----------------------------------------------------------------------------------+
40-
| recipe_path | **Required** Path to recipe directory (can also be path to the .bz2) |
40+
| ``recipe_path`` | **Required** Path to recipe directory (can also be path to the .bz2) |
4141
+-----------------------+----------------------------------------------------------------------------------+
4242

4343

_sources/contribute-recipe.rst.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The following will outline steps used to create the hg19-gaps ggd data recipe:
7575
tabix hg19-gaps-ucsc-v1.bed.gz
7676

7777
* In this data processing script please change the resulting data file names to be short and include all necessary
78-
genomic file extentions. (See the NOTE bellow)
78+
genomic file extensions. (See the NOTE bellow)
7979

8080
You should run the script to make sure it works and that the processed files are what you expect them to be.
8181

@@ -84,17 +84,17 @@ You should run the script to make sure it works and that the processed files are
8484

8585
The final data file names will be changed to reflect the new ggd recipe name. To keep the data file name as
8686
short as possible please rename data files to include only a short name and the genomic file extensions. The name
87-
will be replaced with the ggd recipe name, and the genomic file extention will be kept. For example, in the
88-
hg19-gaps example above *gaps.bed.gz* and the tabix companion *gaps.bed.gz.tbi* will be renmaed to *hg19-gaps.bed.gz*
89-
and *hg19-gaps.bed.gz.tbi*. Because of the complexities with genomic file extentions all extentions will be retained
87+
will be replaced with the ggd recipe name, and the genomic file extension will be kept. For example, in the
88+
hg19-gaps example above *gaps.bed.gz* and the tabix companion *gaps.bed.gz.tbi* will be renamed to *hg19-gaps.bed.gz*
89+
and *hg19-gaps.bed.gz.tbi*. Because of the complexities with genomic file extensions all extensions will be retained
9090
and only the beginning name before the first '.' will be replaced with the recipe name.
9191

9292

9393
.. note::
9494

9595
Make sure that any intermediate files or other files used for data processing are removed after processing. Only the
9696
final processed data files should remain once the script has finished. If extra files are not removed they will be
97-
added as members of the data recipe, which is most likley un-wanted and un-needed.
97+
added as members of the data recipe, which is most likely un-wanted and un-needed.
9898

9999

100100
3. Create a ggd recipe using the ggd cli

0 commit comments

Comments
 (0)