Difference between revisions of "How WormBase writes a concise description"

From WormBaseWiki
Jump to navigationJump to search
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Writing a concise description for a C. elegans gene==
 
==Writing a concise description for a C. elegans gene==
Key facts captured in a concise description:
+
Gene descriptions are concise descriptions about gene function, they appear at the top of gene pages in WormBase in the 'Overview' widget.
 +
 
 +
The following key facts are captured in a concise description, when this information is available in the published literature. Please do not use information from meeting abstracts, Worm Breeder Gazette articles and personal observations/communications.
  
 
*Molecular identity
 
*Molecular identity
Line 11: Line 13:
 
*Sub cellular localization
 
*Sub cellular localization
  
 
+
So, the template for a concise description would look like:
  Molecular identity
+
  '''Molecular identity'''
 
  <Gene> encodes .....;
 
  <Gene> encodes .....;
 +
 +
'''Orthology/Similarity'''
 +
<Gene> is <orthologous, similar) to .....;
 +
 +
'''Process/Pathway'''
 +
<Gene> is <required, functions, regulates, is involved in, is part of> .....;
 +
 +
'''Genetic interaction'''
 +
<Gene> interacts genetically with <gene1, gene2> ..... in <Process, Pathway>;
 +
 +
'''Physical interaction'''
 +
<Protein> physically interacts with <protein, DNA, RNA) .....;
 +
 +
'''Molecular Function'''
 +
<Protein> has ..... activity in <in vitro, in vivo> assays;
 +
 +
'''Tissue Expression'''
 +
<Gene/Protein> is expressed in ..... and expression in ..... is (positively, negatively)
 +
regulated by .....;
 +
 +
'''Sub-cellular localization'''
 +
<Protein> is localized to <cellular component> and expression in <cellular component>
 +
is <positively, negatively> regulated by .....
  
Orthology/Similarity
+
Note that the above template is to be used as a guide, and not all descriptions may follow the exact order or choice of words.   
<Gene> is (drop down with values:orthologous,similar) to .....;
 
 
 
Process/Pathway
 
<Gene> is (drop-down with values:
 
required,functions,regulates,is involved in,is part of) .....;
 
(Sentence needs to be cloned if required)
 
 
 
Genetic interaction with respect to Process or Pathway
 
<Gene> interacts genetically with (drop-down with ontology:WBGenes) with
 
respect to ........;
 
 
Physical interaction
 
<Protein> physically interacts (drop-down with values: invitro, invivo) with
 
  (drop-down with proteins);
 
  
Molecular Function
+
Examples of concise descriptions written by WormBase:
<Protein> has (drop down with ontology:GO molecular function) or ………  activity;
 
  
  Tissue Expression
+
Example: lin-10
  <Gene/Protein> is expressed in …………and expression in ......is (drop-down
+
  lin-10 encodes a PDZ and PTB domain-containing protein that is homologous to mammalian Munc interacting proteins
  with values: positively, negatively) regulated by .......;
+
  (Mint1) and is required for polarized protein localization; LIN-10 is required for proper localization of the
 +
LET-23 EGF receptor to the basolateral membrane of the vulval precursor cells and for proper postsynaptic  localization
 +
  of GLR-1, an AMPA-type glutamate receptor in interneurons; LIN-10 is detected in the cytoplasm, membrane, and
 +
at particularly high levels in the Golgi.
  
Cellular Component/sub-cellular localization
+
Example: lon-1
  <Protein> is localized to (drop-down with ontology:GO cellular component)  
+
  The lon-1 gene encodes a protein belonging to the PR-protein superfamily that is a target of DBL-1 (TGF-beta)  
  or .......and expression in .....is (drop-down with values:
+
  signaling, and that regulates polyploidization and body length.
positively, negatively) regulated by (drop-down with proteins)
 

Latest revision as of 03:38, 3 June 2015

Writing a concise description for a C. elegans gene

Gene descriptions are concise descriptions about gene function, they appear at the top of gene pages in WormBase in the 'Overview' widget.

The following key facts are captured in a concise description, when this information is available in the published literature. Please do not use information from meeting abstracts, Worm Breeder Gazette articles and personal observations/communications.

  • Molecular identity
  • Orthology
  • Process/Pathway
  • Genetic interactions
  • Physical interactions
  • Function/Molecular Activity
  • Tissue Expression
  • Sub cellular localization

So, the template for a concise description would look like:

Molecular identity
<Gene> encodes .....;

Orthology/Similarity
<Gene> is <orthologous, similar) to .....;

Process/Pathway
<Gene> is <required, functions, regulates, is involved in, is part of> .....;

Genetic interaction
<Gene> interacts genetically with <gene1, gene2> ..... in <Process, Pathway>;

Physical interaction
<Protein> physically interacts with <protein, DNA, RNA) .....;

Molecular Function
<Protein> has ..... activity in <in vitro, in vivo> assays;

Tissue Expression
<Gene/Protein> is expressed in ..... and expression in ..... is (positively, negatively) 
regulated by .....;

Sub-cellular localization 
<Protein> is localized to <cellular component> and expression in <cellular component> 
is <positively, negatively> regulated by .....

Note that the above template is to be used as a guide, and not all descriptions may follow the exact order or choice of words.

Examples of concise descriptions written by WormBase:

Example: lin-10

lin-10 encodes a PDZ and PTB domain-containing protein that is homologous to mammalian Munc interacting proteins 
(Mint1) and is required for polarized protein localization; LIN-10 is required for proper localization of the 
LET-23 EGF receptor to the basolateral membrane of the vulval precursor cells and for proper postsynaptic  localization 
of GLR-1, an AMPA-type glutamate receptor in interneurons; LIN-10 is detected in the cytoplasm, membrane, and 
at particularly high levels in the Golgi.

Example: lon-1

The lon-1 gene encodes a protein belonging to the PR-protein superfamily that is a target of DBL-1 (TGF-beta) 
signaling, and that regulates polyploidization and body length.