## These are wiki comments - leave them in so that people can see them when editing the page ## This template may be useful for documenting use cases ## Developed in response to a hackathon request for formalized, detailed use cases ## to help direct implementation proposals || '''Use Case Name''' : ../ProteinBindingSites || || '''For Feature''' : MIMEditor || || '''Editors''': DavidKane || ## EXAMPLE: ## Use Case Name: Representation of Protein Complex ## For Feature: Grouping Function ## Editors: Mr. Knowitall <> == Summary == ## Provide a one paragraph description of the use case A user wants to describe interactions of a protein, binding site by binding site. == Step-by-Step User Action == ## Provide a step-by-step account of how the user would execute the use case. For example: (1) right click on node, (2) choose "expand" from context menu, (3) new view is created, etc... 1. User specifies a protein to be described in more detail 1. User specifies the number of binding sites to be included 1. User specifies the name of each binding site 1. User then uses each binding site in subsequent reactions == Visual Aides == ## Provide attachments to images to illustrate the use case (screenshots, mock-ups, storyboards, etc) Binding sites are indicated with the binding site label sticking out perpendicularly from the protein. An example follows: {{attachment:bindingsite1_061117_dwk.png}} A binding site may also be used in combination with the specification of ../ProteinDomains: {{attachment:bindingsite2_061117_dwk.png}} == Requirements for Cytoscape == ## List the components/functions already in Cytoscape that are relevant to the use case and possible implementations (e.g., "current context menus can be used accomplish step 2 above") ## Also list components/functions that are needed in Cytoscape to execute the use case (e.g., "cytoscape needs to allow for multiple views of the same network for this to work") TBD == Importance == ## 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 is a moderately important feature of the notation. == Other Examples == ## List other applications or relevant examples outside of Cytoscape that provide some or all of the desired functionality (e.g., "You can do this using the group function in PowerPoint"). == Comments == Shared ../MimEditorUseCaseComments BioPax representation TBD GaryBader 2006-12-26 12:28:20 Similar to sub-gene use case for Group API AllanKuchinsky 2007-01-22 05:11:24 case of binding site label sticking out perpendicularly from the protein can be handled with Custom Node Graphic