Skip to content

Commit 53f7d83

Browse files
author
jakebeal
committed
incorporate Herbert's comments
1 parent c196935 commit 53f7d83

File tree

8 files changed

+23
-23
lines changed

8 files changed

+23
-23
lines changed

specification/apdx-examples.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ \section{Examples}\label{sec:examples}
3737

3838
\begin{figure}[h!]
3939
\includegraphics[scale=0.5]{figures/apdx-examples/apdx-exa6.pdf}
40-
\caption{Promoter stored in a plasmid as in \ref{f:apdx:exa3}, except that there is a ribonuclease sites after the promoter rather than restriction sites flanking it.}
40+
\caption{Promoter stored in a plasmid as in \ref{f:apdx:exa3}, except that there is a ribonuclease site after the promoter rather than restriction sites flanking it.}
4141
\label{f:apdx:exa6}
4242
\end{figure}
4343

specification/apdx-glyphs.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ \section{SBOL Visual Glyphs}\label{apdx:symbols}
1414

1515
\subsection{Sequence Feature Glyphs}\label{apdx:sym:feature}
1616

17-
These glyphs represent features of nucleic acid sequences, and include a bounding box and a recommended alignment to the nucleic acid backbone.
17+
These glyphs represent features of nucleic acid sequences, and include a bounding box (grey dashed box) and a recommended alignment to the nucleic acid backbone (grey dashed horizontal line).
1818

1919
\input{glyphscript/glyphs.tex}
2020

2121

2222
\subsection{Molecular Species Glyphs}\label{apdx:sym:species}
2323

24-
These glyphs represent molecular species in a diagram, and include a bounding box but are not connected to any nucleic acid backbone.
24+
These glyphs represent molecular species in a diagram, and include a bounding box (grey dashed box) but are not connected to any nucleic acid backbone.
2525

2626
\input{glyphscript/speciesglyphs.tex}
2727

specification/copyright.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
%% Variation from BBF RFC 0 specs confirmed in email communication with BBF by Jake Beal, 3/21/15
66

7-
Copyright (C) The BioBricks Foundation and all authors listed on this BBF RFC. This work is made available under the Creative Commons Attribution 4.0 International Public License. To view a copy of this license visit \href{https://creativecommons.org/licenses/by/4.0/}{https://creativecommons.org/licenses/by/4.0/}.
7+
Copyright \copyright{} The BioBricks Foundation and all authors listed on this BBF RFC. This work is made available under the Creative Commons Attribution 4.0 International Public License. To view a copy of this license visit \href{https://creativecommons.org/licenses/by/4.0/}{https://creativecommons.org/licenses/by/4.0/}.
88

99
%In addition to the listed authors, the following people are specifically recognized as additional contributors sharing in the copyright (alphabetically by institution):
1010
%\tododeferred{Any additional authors?}
-3 Bytes
Binary file not shown.

specification/glyphs.tex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ \section{SBOL Glyphs}\label{sec:glyphs}
88
This section explains how glyphs are specified and how to add new glyphs.
99

1010
Each SBOL glyph is defined by association with ontology terms, and can be used to represent any diagram element that is well-described by that term.
11-
Currently there are three classes of glyphs, each associated with a different ontology and different class in an SBOL 2 data model:
11+
Currently there are three classes of glyphs, each associated with a different ontology and different class in the SBOL 2 data model:
1212
\begin{itemize}
1313
\item {\bf Sequence Feature Glyphs} describe features of nucleic acid sequences. They are associated with Sequence Ontology terms.
14-
For SBOL 2 data models, this is formally defined as any \sbol{Component} with a compatible term within its associated \sbol{roles},
14+
For the SBOL 2 data model, this is formally defined as any \sbol{Component} with a compatible term within its associated \sbol{roles},
1515
i.e., one that is equal to or a child of at least one term associated with the glyph.
16-
\item {\bf Molecular Species Glyphs} represent any class of molecule whose detailed structure is not being shown using sequence feature glyphs. They are associated with BioPAX terms. For SBOL 2 data models, this is formally defined as any \sbol{FunctionalComponent} with a compatible term within its associated \sbol{types},
16+
\item {\bf Molecular Species Glyphs} represent any class of molecule whose detailed structure is not being shown using sequence feature glyphs. They are associated with BioPAX terms. For the SBOL 2 data model, this is formally defined as any \sbol{FunctionalComponent} with a compatible term within its associated \sbol{types},
1717
i.e., one that is equal to or a child of at least one term associated with the glyph.
1818
\item {\bf Interaction Glyphs} are ``arrows'' indicating functional relationships between sequence features and/or molecular species. They are associated with Systems Biology Ontology terms.
19-
For SBOL 2 data models, this is formally defined as any \sbol{Interaction} with a compatible term within its \sbol{types},
19+
For the SBOL 2 data model, this is formally defined as any \sbol{Interaction} with a compatible term within its \sbol{types},
2020
i.e., one that is equal to or a child of at least one term associated with the glyph,
2121
and with a compatible \sbol{Participation} at the head and tail of the arrow.
2222
\end{itemize}

specification/imgsrc/2.pptx

-1 Bytes
Binary file not shown.

specification/language.tex

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ \section{SBOL Visual Diagram Language}
66
An SBOL Visual diagram represents information about the structure of a nucleic acid design and its associated molecular species and interactions.
77
%
88
If desired, an SBOL Visual diagram may also be associated with a machine-interpretable model (e.g., in SBOL, GenBank, or SBML format).
9-
In this document we describe the association for SBOL 2 data models, which provides a formal semantic grounding for all elements of an SBOL Visual diagram, but equivalent associations may be made between diagram elements and other models.
9+
In this document we describe the association for the SBOL 2 data model, which provides a formal semantic grounding for all elements of an SBOL Visual diagram, but equivalent associations may be made between diagram elements and other models.
1010
%
11-
In terms of SBOL 2 data models, the description of a nucleic acid design is formally defined as representation of a \sbol{ComponentDefinition} with a nucleic acid \sbol{type}, the \sbol{Component} and \sbol{SequenceAnnotation} objects describing the features and sub-structure of the design, and \sbol{SequenceConstraint} information on the relative positions of such elements.
11+
In terms of the SBOL 2 data model, the description of a nucleic acid design is formally defined as a representation of a \sbol{ComponentDefinition} with a nucleic acid \sbol{type}, the \sbol{Component} and \sbol{SequenceAnnotation} objects describing the features and sub-structure of the design, and \sbol{SequenceConstraint} information on the relative positions of such elements.
1212
%
1313
The description of interactions between some number of nucleic acid designs and other molecular species is formally defined as a representation of a \sbol{ModuleDefinition}, the \sbol{FunctionalComponent} objects describing the nucleic acid designs and other molecular species, and the \sbol{Interaction} and \sbol{Participation} objects describing their functional relationships.
1414

@@ -41,9 +41,9 @@ \subsection{Nucleic Acid Backbone}
4141
\label{s:lang:backbone}
4242

4343
A diagram for a nucleic acid construct is based around a single or double line, representing the nucleic acid backbone.
44-
Information about features of the construct can then be represented by attaching nucleic acid glyphs to the backbone, as defined below in \ref{s:lang:nacomponent}
44+
Information about features of the construct can then be represented by attaching nucleic acid glyphs to the backbone, as defined below in \ref{s:lang:nacomponent}.
4545
%
46-
In terms of SBOL 2 data models, the backbone represents a \sbol{ComponentDefinition} with a nucleic acid \sbol{type} (e.g., DNA, RNA), and the features represent \sbol{Component} and \sbol{SequenceAnnotation} members of the \sbol{ComponentDefinition}.
46+
In terms of the SBOL 2 data model, the backbone represents a \sbol{ComponentDefinition} with a nucleic acid \sbol{type} (e.g., DNA, RNA), and the features represent \sbol{Component} and \sbol{SequenceAnnotation} members of the \sbol{ComponentDefinition}.
4747

4848
\begin{enumerate}
4949
\item Lines in some cases indicate strand count.
@@ -82,7 +82,7 @@ \subsection{Nucleic Acid Sequence Features}
8282

8383
A glyph in contact with a nucleic acid backbone indicates a feature of the nucleic acid sequence.
8484
%
85-
In terms of SBOL 2 data models, this is either a \sbol{SequenceFeature} or a \sbol{Component} with a nucleic acid \sbol{type} that is contained within the \sbol{ComponentDefinition} associated with that nucleic acid backbone.
85+
In terms of the SBOL 2 data model, this is either a \sbol{SequenceFeature} or a \sbol{Component} with a nucleic acid \sbol{type} that is contained within the \sbol{ComponentDefinition} associated with that nucleic acid backbone.
8686
The \sbol{Component} may be contained either directly, as one of the \sbol{components} of the \sbol{ComponentDefinition}, or recursively through a sequence of such containments.
8787

8888
\begin{enumerate}
@@ -120,7 +120,7 @@ \subsection{Nucleic Acid Sequence Features}
120120
\end{figure}
121121

122122
\item Nucleic acid features in a sequential relationship SHOULD be drawn from 5' left to 3' right on the inline strand and from 5' right to 3' left on the reverse complement strand.
123-
In terms of SBOL 2 data models, this indicates a \sbol{SequenceConstraint} on the relative ordering of two features.
123+
In terms of the SBOL 2 data model, this indicates a \sbol{SequenceConstraint} on the relative ordering of two features.
124124

125125
\item Nucleic acid features that do not overlap in their locations SHOULD NOT have glyphs whose bounding boxes overlap.
126126
An example is provided in~\ref{exa:2d}.
@@ -144,7 +144,7 @@ \subsection{Nucleic Acid Sequence Features}
144144
\end{figure}
145145

146146
\item A nucleic acid feature SHOULD be represented using a glyph defined in \ref{apdx:sym:feature}. In this case, the feature MUST be contained within at least one of the glyph's associated terms.
147-
In terms of SBOL 2 data models, this means the glyph is equal to or a parent of at least one of the \sbol{roles} for the \sbol{Component} or its associated \sbol{ComponentDefinition}.
147+
In terms of the SBOL 2 data model, this means the glyph is equal to or a parent of at least one of the \sbol{roles} for the \sbol{Component} or its associated \sbol{ComponentDefinition}.
148148
Moreover, the glyph used SHOULD be the RECOMMENDED variant of the most specific applicable glyph. Note that novel glyphs not defined in \ref{apdx:sym:feature} MAY be used, but SHOULD be proposed for adoption as described in \ref{sec:extension}.
149149
Examples are provided in~\ref{exa:2f}.
150150
\begin{figure}[h!]
@@ -162,12 +162,12 @@ \subsection{Nucleic Acid Sequence Features}
162162
\subsection{Molecular Species}
163163
A glyph that is not in contact with any backbone represents any class of molecule whose detailed structure is not being shown using sequence feature glyphs.
164164
In other words, either not a nucleic acid (e.g., proteins, small molecules) or else an ``uninteresting'' nucleic acid (e.g., showing a transcribed mRNA, but not the features of its sequence).
165-
In terms of SBOL 2 data models, this is a \sbol{FunctionalComponent} that is contained within a \sbol{ModuleDefinition} implicit in the diagram.
165+
In terms of the SBOL 2 data model, this is a \sbol{FunctionalComponent} that is contained within a \sbol{ModuleDefinition} implicit in the diagram.
166166

167167
\begin{enumerate}
168168
\item A molecular species glyph MUST NOT contact any nucleic acid backbone with any part of its bounding box.
169169
\item A molecular species SHOULD be represented using a glyph defined in \ref{apdx:sym:species}. In this case, the species MUST be contained within at least one of the glyph's associated terms.
170-
In terms of SBOL 2 data models, this means the glyph is equal to or a parent of at least one of the \sbol{types} for the associated \sbol{ComponentDefinition}.
170+
In terms of the SBOL 2 data model, this means the glyph is equal to or a parent of at least one of the \sbol{types} for the associated \sbol{ComponentDefinition}.
171171
Moreover, the glyph used SHOULD be the RECOMMENDED variant of the most specific applicable glyph. Note that novel glyphs not defined in \ref{apdx:sym:species} MAY be used, but SHOULD be proposed for adoption as described in \ref{sec:extension}.
172172
\end{enumerate}
173173

@@ -176,7 +176,7 @@ \subsection{Interaction}
176176

177177
A directed edge ``arrow'' attached to one or more glyphs indicates a functional interaction involving those elements.
178178
The roles of the elements is indicated by their position at the head or tail of the edge.
179-
In terms of SBOL 2 data models, this is an \sbol{Interaction}, with either one or two \sbol{Participation} relationships, their \sbol{role} set by position at the head or tail of the edge.
179+
In terms of the SBOL 2 data model, this is an \sbol{Interaction}, with either one or two \sbol{Participation} relationships, their \sbol{role} set by position at the head or tail of the edge.
180180
An example is provided in~\ref{exa:4}.
181181

182182
\begin{figure}[h!]
@@ -207,13 +207,13 @@ \subsection{Interaction}
207207
\end{figure}
208208

209209
\item An interaction SHOULD be represented using a glyph defined in \ref{apdx:sym:interaction}. In this case, the interaction type MUST be contained within at least one of the glyph's associated terms.
210-
In terms of SBOL 2 data models, this means the glyph is equal to or a parent of at least one of the \sbol{types} for the \sbol{Interaction}, and that each associated \sbol{Participation} object has a \sbol{role} compatible with its position on the head or tail of the edge.
210+
In terms of the SBOL 2 data model, this means the glyph is equal to or a parent of at least one of the \sbol{types} for the \sbol{Interaction}, and that each associated \sbol{Participation} object has a \sbol{role} compatible with its position on the head or tail of the edge.
211211
Moreover, the glyph used SHOULD be the RECOMMENDED variant of the most specific applicable glyph. Note that novel glyphs not defined in \ref{apdx:sym:interaction} MAY be used, but SHOULD be proposed for adoption as described in \ref{sec:extension}.
212212
\end{enumerate}
213213

214214

215215
\subsection{Labels}
216-
The name of any object in a diagram is RECOMMENDED to be displayed as text within, adjacent to, or otherwise clearly visually connected to the object's associated glyph. In terms of SBOL 2 data models, this is the \sbol{name} property, and if no \sbol{name} is supplied then the \sbol{displayId} MAY be used instead.
216+
The name of any object in a diagram is RECOMMENDED to be displayed as text within, adjacent to, or otherwise clearly visually connected to the object's associated glyph. In terms of the SBOL 2 data model, this is the \sbol{name} property, and if no \sbol{name} is supplied then the \sbol{displayId} MAY be used instead.
217217
Examples are provided in~\ref{exa:5}.
218218

219219
\begin{figure}[h!]

specification/purpose.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
\section{Purpose}
33
% -----------------------------------------------------------------------------
44

5-
People who are engineering biological organisms often find it useful to communicate in
5+
People who engineer biological organisms often find it useful to communicate in
66
diagrams, both about the structure of the nucleic acid sequences that they are engineering
77
and about the functional relationships between sequence features and other molecular species.
88
%
@@ -23,8 +23,8 @@ \section{Purpose}
2323

2424
\subsection{Relation to Data Models}
2525

26-
In order to ground SBOL Visual with precise definitions, we reference its visual elements to data models with a well-defined semantics.
27-
In particular, glyphs in SBOL Visual are defined in terms of their relation to the SBOL 2 data model and terms in the Sequence Ontology~\citep{SequenceOntology},
26+
In order to ground SBOL Visual with precise definitions, we reference its visual elements to data models with well-defined semantics.
27+
In particular, glyphs in SBOL Visual are defined in terms of their relation to the SBOL 2 data model (as defined in BBF RFC 112) and terms in the Sequence Ontology~\citep{SequenceOntology},
2828
the Systems Biology Ontology~\citep{SBO}, and BioPAX~\citep{BioPAX}.
2929

3030
SBOL Visual is not intended to represent designs at the same level of detail as these data models.

0 commit comments

Comments
 (0)