## page was renamed from EditAnnotation ## 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''' : ../EditAnnotation || || '''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 add or edit annotations to a feature in a map. == 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 selects feature in the map 1. User specifies that the feature’s annotations should be edited 1. User adds a pubmed id, or other reference as evidence for the presence of the feature in the map 1. User repeats step 3, until all literature citations have been added 1. User optionally adds additional textual explanation for the annotation == Visual Aides == ## Provide attachments to images to illustrate the use case (screenshots, mock-ups, storyboards, etc) == 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"). Annotations are very important for the credibility of maps that seek wide usage. However, the process of adding annotations should not be tightly coupled to the process of creating and editing the map. So the process of adding annotations needs to be able to happen afterwards. == 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 ---- AllanKuchinsky - 2007-01-19 02:59:30 1. At the user interface level, would it be useful to be able to drag/drop a literature reference, file reference, etc. onto a Cytoscape node/feature and have that reference incorporated into the node's/feature's annotations? For example, drags a URL from web browser and drops it onto a Cytoscape node. 2. At the model level, we might want to define a Cytoscape construct to specifically support a collection of citations/references and their associated metadata. For example, something along the lines of the text source object in the Agilent Literature Search tool. 3. To support collaborative use of the maps, we could store a user id and timestamp with the annotation. ---- AllanKuchinsky - 2007-01-22 05:36:56 arbitrary graphical annotations functionality, for support of use cases such as GenMAPP and MiMs, is a major priority for Cytoscape versions 2.5 and 2.6. RFCs are forthcoming. ---- MiritAladjem - 2007-02-01 09:30:51 Allan all three features in your first comment will be useful, we agree that it is cool.