belbio / bel

BEL python package
https://bel.rtfd.io
Apache License 2.0
7 stars 3 forks source link

Add examples to BEL YAML file #12

Open wshayes opened 6 years ago

wshayes commented 6 years ago

From @wshayes on August 30, 2017 13:26

For each of the function signatures and computed edge signatures, we should add an example BEL statement list:

examples:
- p(HGNC:F2) increases sec(p(HGNC:VWF))

_Copied from original issue: belbio/bellang#29

wshayes commented 6 years ago

From @davidchen on August 30, 2017 13:28

Would this go directly in as a comment in the YAML or as part of an "example" attribute of each signature? Or should these be in the wiki?

wshayes commented 6 years ago

From @davidchen on August 30, 2017 13:29

If we simply have an "examples" list, it may be hard to tell which example is supposed to represent which signature.

wshayes commented 6 years ago

Each example should be associated with a specific function or computed edge signature. This isn't urgent. Some of the functions and computed edges would be best served with multiple examples which explains why I suggest a list rather than a single example.