Difference between revisions of "User:Scmohr/Part Doc Guide"
(→Guide to Registry Documentation) |
|||
Line 1: | Line 1: | ||
=Guide to Registry Documentation= | =Guide to Registry Documentation= | ||
− | This guide explains how to read and interpret the information available that documents a part in the Registry. | + | This guide explains how to read and interpret the information available that documents a part in the Registry. It is intended to provide comprehensive assistance to new users of the Registry. It may clarify points for some veteran users as well. |
==Overview== | ==Overview== | ||
Line 34: | Line 34: | ||
A '''descriptive name that avoids specialized abbreviations''' so that it can be quickly understood by anyone with a basic knowledge of molecular biology. Example: "Transcriptional activator protein luxR." Generally these names can be found in specialized databases like [http://www.uniprot.org/UniProt UniProt]. Such databases also list synonymous names and common abbreviations (see next item). | A '''descriptive name that avoids specialized abbreviations''' so that it can be quickly understood by anyone with a basic knowledge of molecular biology. Example: "Transcriptional activator protein luxR." Generally these names can be found in specialized databases like [http://www.uniprot.org/UniProt UniProt]. Such databases also list synonymous names and common abbreviations (see next item). | ||
+ | |||
+ | ===Short name=== | ||
+ | |||
+ | Abbreviated names become the norm in laboratory work, but often different groups make up different nicknames for the same object. The Registry attempts to avoid the confusion this may cause by using consistent short names. Wherever possible we select these on the basis of the currently accepted standard in the relevant field. Thus, for proteins we use the preferred names given in UniProt. Example: "BSMT1" (for BBa_J45004). Because the gene names for many proteins are well-established and used consistently, they become handy nicknames for their protein products. Example: "LuxR" (for Obviously, when a part is created ''de novo,'' the designer gets to coin its nickname. | ||
==DESIGN PAGE== | ==DESIGN PAGE== |
Revision as of 18:56, 9 July 2008
Contents
Guide to Registry Documentation
This guide explains how to read and interpret the information available that documents a part in the Registry. It is intended to provide comprehensive assistance to new users of the Registry. It may clarify points for some veteran users as well.
Overview
Each part* in the Registry has two components: (a) physical DNA carried by a plasmid vector stored at -80 degrees Celsius, and (b) documentation on the parts.igem.org server. For some parts, only documentation is available. To use such a part you must either synthesize the DNA or reconstruct the part from the documented design information.
In what follows, each item used to document parts will be defined and its use(s) explained. The items are presented in the order that they appear on the pages corresponding to the part.
MAIN PAGE
Part Number
This is a "unique identifier" (as that term is used in computer science). It labels the part and all information connected with it. Example: BBa_J45004. This part encodes an enzyme used to construct a pleasant (!) odor-generating system in E. coli. The prefix BBa denotes a BioBrick part from the alpha release of BioBrick* standard biological parts and the J designates the part category. For details see: Part Names. The numbers indicate the specific part.
Part Icon
The Registry uses a set of icons to represent parts and standardize the schematic diagrams used to describe devices and systems. Example: represents a protein-coding sequence. The icon set remains incomplete and under development. Check with Part Names to find currently used icons.
Status Box
At the upper right-hand corner of the Main Page you will see a green box with two lines. The upper line indicates whether or not DNA corresponding to that part is available from the Registry, and the lower line reports the current experience with the part as reported on the Experience Page.
Designer/iGEM Team
The name of one person responsible for the submission of the part and its documentation, together with the name of the affiliated iGEM team or research laboratory as appropriate. Example: __________________
Date of Submission
This is an automatically generated field and refers to time at the Registry. Example: 2006-06-07 (i.e., year/month/day)
Full name
A descriptive name that avoids specialized abbreviations so that it can be quickly understood by anyone with a basic knowledge of molecular biology. Example: "Transcriptional activator protein luxR." Generally these names can be found in specialized databases like [http://www.uniprot.org/UniProt UniProt]. Such databases also list synonymous names and common abbreviations (see next item).
Short name
Abbreviated names become the norm in laboratory work, but often different groups make up different nicknames for the same object. The Registry attempts to avoid the confusion this may cause by using consistent short names. Wherever possible we select these on the basis of the currently accepted standard in the relevant field. Thus, for proteins we use the preferred names given in UniProt. Example: "BSMT1" (for BBa_J45004). Because the gene names for many proteins are well-established and used consistently, they become handy nicknames for their protein products. Example: "LuxR" (for Obviously, when a part is created de novo, the designer gets to coin its nickname.
DESIGN PAGE
Rationale
A brief description of the method chosen to construct the part and the reasons for the choices made. This should also provide links to other parts created for the same project.
EXPERIENCE PAGE
HARD INFORMATION PAGE
____________________
- all terms marked with an asterisk are defined in the [Registry Glossary].