Cytoscape Wiki|
Size: 4594
Comment:
|
Size: 5661
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ---- /!\ '''Edit conflict - other version:''' ---- | |
| Line 3: | Line 2: |
|
## This template may be useful for documenting use cases ## Developed in response to a hackathon request for formalized, detailed use cases |
## This template may be useful for documenting use cases ## Developed in response to a hackathon request for formalized, detailed use cases |
| Line 7: | Line 5: |
|
|| '''Use Case Name''' : ... || || '''For Feature''' : ... || || '''Editors''': ... || ## EXAMPLE: |
||'''Use Case Name''' : Sub-Gene Data Visualization|| ||'''For Feature''' : Group-API || ||'''Editors''': Nathan Salomonis || ## EXAMPLE: |
| Line 16: | Line 12: |
| Line 21: | Line 16: |
|
We would like to be able to represent detailed sub-gene data in a second window after selecting a node from the parent graph. These below use cases apply to datasets where many different pieces of data (e.g. probesets or interaction partners) are available, that themselves can be represented as distinct nodes. Examples include individual probes or replicate spots from a microarray dataset, data from distinct time-point comparisons in a dataset polymorphism data from whole genome SNP experiments*, exon and exon-junction specific data*, ChIP on chip experiment data* and interaction partners for a node in the parent network*. Examples with an asterisk are illustrated below. |
We would like to be able to represent detailed sub-gene data in a second window after selecting a node from the parent graph. These below use cases apply to datasets where many different pieces of data (e.g. probesets or interaction partners) are available, each of which would be represented as distinct nodes. Examples include individual probes or replicate spots from a microarray dataset, data from distinct time-point comparisons, polymorphism data from whole genome SNP experiments*, exon and exon-junction specific data*, ChIP on chip experiment data* and interaction partners for a node in the parent network*. Examples with an asterisk are illustrated below. |
| Line 26: | Line 20: |
| '''Associating Data for Sub-Gene Views''' | |
| Line 27: | Line 22: |
|
'''Associating Data for Sub-Gene Views''' 1. To view data with specialized sub-gene views (e.g. SNP view with annotations), first requires a relational database containing at a minimum, associations to genes or proteins. The GenMAPP group is currently designing a database that will support specific ID systems for microarray platforms that assay for specific sub-gene entities. This database will also have to accomidate new relationships appended to the database by the user for unsupported ID systems. For generic case, only those relationships need to connect individual array IDs (or other elements) to a gene are required. For more specialized cases, such as viewing SNP annotations associated with an array ID, these additional annotations must be stored in the relational database. 2. Once the user determines whether the primary ID from their data is supported in the gene database and a sub-gene view to select, the user will: a. upload their data using a specialized interface b. specify filters for node coloring c. choose the sub-gene visualization methods These options will stored along with the user raw data in a relational database. |
1. To view data with specialized sub-gene views (e.g. SNP view with annotations), first requires a relational database containing at a minimum, associations to genes or proteins. The GenMAPP group is currently designing a database that will support specific ID systems for microarray platforms that assay for specific sub-gene entities. This database will also have to accomidate new relationships appended to the database by the user for unsupported ID systems. For generic case, only those relationships need to connect individual array IDs (or other elements) to a gene are required. For more specialized cases, such as viewing SNP annotations associated with an array ID, these additional annotations must be stored in the relational database. 1. Once the user determines whether the primary ID from their data is supported in the gene database and a sub-gene view to select, the user will: 1. upload their data using a specialized interface 2. specify filters for node coloring 3. choose the sub-gene visualization methods These options will stored along with the user raw data in a relational database. |
| Line 36: | Line 30: |
| Line 37: | Line 32: |
|
2. Select the gene database used when loading the raw data from a context menu. 3. Select the user database with data and criterion from a context menu. 4. Select the sub-gene view of interest from a context menu. Once selected, by default the right click option will activate the sub-gene view. |
1. Select the gene database used when loading the raw data from a context menu. 1. Select the user database with data and criterion from a context menu. 1. Select the sub-gene view of interest from a context menu. Once selected, by default the right click option will activate the sub-gene view. |
| Line 42: | Line 37: |
| Line 43: | Line 39: |
|
2. Select a node in the child network to view more detailed annotations provided from the gene database. |
1. Select a node in the child network to view more detailed annotations provided from the gene database. |
| Line 46: | Line 41: |
|
## Provide attachments to images to illustrate the use case (screenshots, mock-ups, storyboards, etc) attachment:sub-gene-vis.jpg |
. attachment:sub-gene-vis.jpg |
| Line 52: | Line 45: |
| In the most simple example, multiple array IDs associated with a gene, Cytoscape will need to sort (based on node name) and horizontally align the nodes in the child network. For many nodes, multiple rows will need to be created. In the more complex cases (see above illustration), annotations will need to be displayed as labels (e.g. for SNPs: where for that gene does the SNP occur, for ChIP on chip: what transcript factor binding matrices overlap with the probed region, for interaction partners: the source of the interaction). In the case of exon and exon-junction data, a graphical display could be shown above the exon level probe data (each node represents a probeset on the array, annotated in the gene database according to which annotated exon it overlaps with), where the graphical display of each exon and intron is sized according to the layout of these nodes. This same method of layout could be used to view exon level data in the context domains, by graphically displaying the domain regions and domain names, scaled to the corresponding nodes below. According to this model, all data for the original identifiers loaded are shown in the sub-gene view, rather than summarizing this information in a way that is biased based on existing annotations. This is important, since we don't want to make broad generalizations or conclusions for the user which may be incorrect. | |
| Line 54: | Line 47: |
|
## Describe whether this use case is critical and how frequently users would come across it. Describe common work flows that might involve the use case (e.g., "this use case comes up regularly, on a weekly basis, whenever we want to analyze our protein superfamily networks"). |
This use case is necessary for any dataset with more than one piece of information linked to a single gene level node. Specific sub-gene views provide biological context and annotations for the original sub-gene identifiers loaded. |
| Line 58: | Line 50: |
| Line 60: | Line 51: |
| Line 62: | Line 52: |
|
---- /!\ '''Edit conflict - your version:''' ---- Describe groupAPI/UseCase 3A here. ---- /!\ '''End of edit conflict''' ---- |
Use Case Name : Sub-Gene Data Visualization |
For Feature : Group-API |
Editors: Nathan Salomonis |
Summary
We would like to be able to represent detailed sub-gene data in a second window after selecting a node from the parent graph. These below use cases apply to datasets where many different pieces of data (e.g. probesets or interaction partners) are available, each of which would be represented as distinct nodes. Examples include individual probes or replicate spots from a microarray dataset, data from distinct time-point comparisons, polymorphism data from whole genome SNP experiments*, exon and exon-junction specific data*, ChIP on chip experiment data* and interaction partners for a node in the parent network*. Examples with an asterisk are illustrated below.
Step-by-Step User Action
Associating Data for Sub-Gene Views
- To view data with specialized sub-gene views (e.g. SNP view with annotations), first requires a relational database containing at a minimum, associations to genes or proteins. The GenMAPP group is currently designing a database that will support specific ID systems for microarray platforms that assay for specific sub-gene entities. This database will also have to accomidate new relationships appended to the database by the user for unsupported ID systems. For generic case, only those relationships need to connect individual array IDs (or other elements) to a gene are required. For more specialized cases, such as viewing SNP annotations associated with an array ID, these additional annotations must be stored in the relational database.
- Once the user determines whether the primary ID from their data is supported in the gene database and a sub-gene view to select, the user will:
- upload their data using a specialized interface
- specify filters for node coloring
- choose the sub-gene visualization methods
Selecting a Sub-Gene View
- Open a network
- Select the gene database used when loading the raw data from a context menu.
- Select the user database with data and criterion from a context menu.
- Select the sub-gene view of interest from a context menu. Once selected, by default the right click option will activate the sub-gene view.
Visualizing Sub-Gene Data
- Right click on a node in the network. This will open a new window (child network) containing the sub-gene view.
- Select a node in the child network to view more detailed annotations provided from the gene database.
Visual Aides
- attachment:sub-gene-vis.jpg
Requirements for Cytoscape
In the most simple example, multiple array IDs associated with a gene, Cytoscape will need to sort (based on node name) and horizontally align the nodes in the child network. For many nodes, multiple rows will need to be created. In the more complex cases (see above illustration), annotations will need to be displayed as labels (e.g. for SNPs: where for that gene does the SNP occur, for ChIP on chip: what transcript factor binding matrices overlap with the probed region, for interaction partners: the source of the interaction). In the case of exon and exon-junction data, a graphical display could be shown above the exon level probe data (each node represents a probeset on the array, annotated in the gene database according to which annotated exon it overlaps with), where the graphical display of each exon and intron is sized according to the layout of these nodes. This same method of layout could be used to view exon level data in the context domains, by graphically displaying the domain regions and domain names, scaled to the corresponding nodes below. According to this model, all data for the original identifiers loaded are shown in the sub-gene view, rather than summarizing this information in a way that is biased based on existing annotations. This is important, since we don't want to make broad generalizations or conclusions for the user which may be incorrect.
Importance
This use case is necessary for any dataset with more than one piece of information linked to a single gene level node. Specific sub-gene views provide biological context and annotations for the original sub-gene identifiers loaded.
Other Examples