annotate README.rst @ 9:5fa1f0ca69cc draft default tip

planemo upload commit f59eaefa6c10f425809c7cb6d2e3df6164fa3a15
author nathandunn
date Sun, 25 Sep 2016 21:59:32 -0400
parents 15016fee2bc4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
850bb90bd667 planemo upload commit b529f45bf9fecbac1457a65b6b81e3b95200fced
nathandunn
parents:
diff changeset
1
850bb90bd667 planemo upload commit b529f45bf9fecbac1457a65b6b81e3b95200fced
nathandunn
parents:
diff changeset
2
2
3107c58d5c85 planemo upload commit 24de1c1405f1f79859f764da60ba068f2dc88cc6
nathandunn
parents: 1
diff changeset
3 This project wraps the Gene Ontology SOLR services (GOLR) exposed by the `Monarch initiative <https://monarchinitiative.org>`_
0
850bb90bd667 planemo upload commit b529f45bf9fecbac1457a65b6b81e3b95200fced
nathandunn
parents:
diff changeset
4
2
3107c58d5c85 planemo upload commit 24de1c1405f1f79859f764da60ba068f2dc88cc6
nathandunn
parents: 1
diff changeset
5 .. image:: https://zenodo.org/badge/doi/10.5281/zenodo.56412.svg
3107c58d5c85 planemo upload commit 24de1c1405f1f79859f764da60ba068f2dc88cc6
nathandunn
parents: 1
diff changeset
6 :target: http://dx.doi.org/10.5281/zenodo.56412
0
850bb90bd667 planemo upload commit b529f45bf9fecbac1457a65b6b81e3b95200fced
nathandunn
parents:
diff changeset
7
4
4be31c7908af planemo upload commit 9608f0096fcafb3202cde18a424264ad66130a21
nathandunn
parents: 2
diff changeset
8 .. .. image:: demo.png
0
850bb90bd667 planemo upload commit b529f45bf9fecbac1457a65b6b81e3b95200fced
nathandunn
parents:
diff changeset
9
4
4be31c7908af planemo upload commit 9608f0096fcafb3202cde18a424264ad66130a21
nathandunn
parents: 2
diff changeset
10 .. .. image:: arguments.png
0
850bb90bd667 planemo upload commit b529f45bf9fecbac1457a65b6b81e3b95200fced
nathandunn
parents:
diff changeset
11
2
3107c58d5c85 planemo upload commit 24de1c1405f1f79859f764da60ba068f2dc88cc6
nathandunn
parents: 1
diff changeset
12
8
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
13 =========
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
14 To Update
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
15 =========
7
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
16
8
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
17 ::
7
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
18
8
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
19 planemo test
7
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
20
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
21
8
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
22 If one of them fails, then we have to make sure that the different tests are just data being updated, but not an error.
7
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
23
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
24 For each xml test do:
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
25
8
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
26 ::
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
27
7
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
28 planemo test monarch-phenotypes-for-disease.xml --update_test_data
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
29
8
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
30 which will update the test data.
7
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
31
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
32 If the test data is non-empty:
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
33
8
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
34 ::
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
35
7
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
36 git status | grep modified | cut -c14-1000 | xargs wc -l
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
37
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
38 then commit.
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
39
8
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
40 ------------------------------
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
41 Sending update to the Toolshed
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
42 ------------------------------
7
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
43
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
44 Using this reference for publishing: http://planemo.readthedocs.io/en/latest/publishing.html
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
45
8
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
46 ::
15016fee2bc4 planemo upload commit 00e0e60deed9cc2ef83d47a3182cd6c84b8f5b41
nathandunn
parents: 7
diff changeset
47
7
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
48 planemo shed_lint --tools
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
49
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
50 planemo shed_diff --shed_target toolshed
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
51
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
52 planemo shed_update --check_diff --shed_target toolshed
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
53
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
54 planemo shed_test --shed_target toolshed
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
55
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
56
61d8060bf2ed planemo upload commit cc498cdcd54060998f80018b8f2dc92345adc414
nathandunn
parents: 4
diff changeset
57