Specifications for a Community Annotation Form

From WormBaseWiki
Jump to navigationJump to search

Description of fields

Since this is for the community, it might be worth having a short one-line instruction for each field (shown in italics here), on top of the box for entering data:

Please see guidelines on how to write a concise description: http://wiki.wormbase.org/index.php/How_WormBase_writes_a_concise_description

1. Enter your e-mail address.

E-mail: Free text box

J: Can the form map e-mail to WBPerson ID, if not alerts relevant person to create one. -- how about autocomplete on email and/or name to display name + email, then they pick it. and if it's a completely new person/email, after submission give them a link to create a new person through the person form.

2. Enter a gene name, example abc-1, the form will convert it to the appropriate WBGene ID. Match genes like the OA (whatever it does, whether it's only loci or synonyms, or however it works)

Gene: Drop-down, auto complete obo, same as WBGene field in most OA interfaces.

J: Can there be a 'No match' option maybe right at the top, if user chooses this, then they will need to use a free text box, how do we force this sequence? -- Sure, there'll be the autocomplete, and a button next to it that says "no match found", when that button is clicked, a new field "non-wormbase gene" shows up with a free text field.

3. Choose the appropriate species.

Species: Autocomplete, Drop-down with predetermined values.

J: Same feature, 'No Match' with free text box option, if desired species is not present in dropdown. -- same as gene

4.Write a concise description for the gene you've chosen.

Concise description: A big box for free-text, similar to the 'Description Text' box in the Concise Description OA.

5. Enter a published paper reference, either a PMID, WBPaper identifier or a DOI. Please note that WormBase will not accept meeting abstracts, Gazette articles or personal communications as references.

Reference: Auto-complete obo

J: Same feature, 'No match'and free text box. -- autocomplete on the paper field like the OA ? because that does allow abstracts, that is, it allows any papers, doesn't it ?

Also, once PMID or WBPaper is entered, can form pull up Paper information, meaning title etc etc, similar to the OA pulling up paper information in Term information, or what P2GO does. -- only will show paper information of papers that do match, not of a PMID (it won't go to NCBI to download the XML and display it)