Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A notebook that creates an example of an SBOL2 Component #33

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

Yehuda-Binik
Copy link
Contributor

Addresses #15. Notebook does not include examples for both MapsTo and measures properties, as those should be shown in their respective Notebooks.

examples/sbol2/CreatingSBOL2Objects/Component.ipynb Outdated Show resolved Hide resolved
"cell_type": "markdown",
"metadata": {},
"source": [
"Create a plasmid `Sequence` object and add it to the document"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think all the "plasmid" statements here should be "promoter"

"example_gene_component_definition.addRole(sbol2.SO_GENE)\n",
"example_gene_component_definition.addRole(sbol2.SO_PROMOTER)\n",
"doc.addComponentDefinition(example_gene_component_definition)\n",
"example_gene_component_definition.components.add(promoter_component)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you put in a CDS and an ordering constraint, then you can also demonstrate how pySBOL2 lets you calculate a sequence for the containing ComponentDefinition, using the ComponentDefinition.compile method.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel that this functionality can be shown off in the sequence_constraint notebook. Since that is where sequence constraints are going to be shown off in full

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's reasonable if you want to keep this simple.
I would suggest leaving a comment in here that points to that notebook, though.

"cell_type": "markdown",
"metadata": {},
"source": [
"Now we will add a `role` and a `roleIntegration` to the cds_component"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this part of the notebook, I would like to have an example of a component that has its role property set along with a roleIntegration of OverrideRoles. However, I do not know what example scenario to use to demonstrate this functionality. I was thinking perhaps I could use an activator ComponentDefinition that is actually being used as a repressor. However, I'm not sure if this example makes sense. In addition, there does not seem to be predefined pysbol constants of Activator and Repressor so I think I would have to find the relevant ontology and create my own URI. How would I go about doing this? Is this the path I should be going down? Any assistance would be appreciated.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The overrideRoles value is very rarely used, and I'm not sure we have many good examples. I don't think that I've ever used it myself.

@cjmyers , do you have a good example here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants