User Data Submission (Phenotypes)

User Data Submission

Introduction

This guide is designed to ensure that all investigators and researchers follow consistent and clear procedures. By adhering to these protocols, we can maintain high-quality data and facilitate better understanding and analysis. Please read through the following steps carefully.

clear descriptions

Step-by-Step Protocol (simplified)

  1. Naming Strains:
    • Use alphanumeric names of the same length, starting with two or three letters (e.g., BXD1).
    • Avoid using short or purely numeric names to reduce errors and improve user experience.
  2. InbredSetId:
    • Use the GeneNetwork identifier "InbredSetId" for groups of animals/genotypes.
    • Ensure all animals/genotypes in a group have the same InbredSetId (e.g., 100).
  3. Description Field:
    • Always provide an original description for each phenotype.
    • If the description is missing, back-fill it with a dated entry.
    • Ensure descriptions are clear and understandable.
  4. Trait Descriptions:
    • Rewrite and validate all descriptions to be clear and informative.
    • Use simple language that a high school student can understand.
    • Include specific details such as the stage of the organism, conditions, and measurements.
  5. General Guidelines:
    • Follow naming conventions for traits, starting with approved general category terms (e.g., "Central nervous system, pharmacology, endocrinology:").
    • Avoid starting descriptions with generic or uninformative words.
    • Use terms that reflect the intent of the assay rather than specific instrumental names.
  6. Units of Measurement:
    • Include mandatory units of measurement in square brackets (e.g., [sec], [cm]).
    • Describe ordinal scales within the brackets if applicable.
  7. Sex and Age:
    • Clearly state the sex and age of subjects (e.g., "in 100 to 200-day-old males and females").
    • Avoid using abbreviations or hyphens that can be confusing.
  8. Consistency and Clarity:
    • Ensure all descriptions conform to common rules of English and are free of typos.
    • Use commas appropriately and avoid extraneous words.
    • Use American spelling and avoid all caps in descriptions.

Step-by-Step Protocol (Extended)

Phenotype trait names in GeneNetwork should have this general form when possible:

  1. Your description should start with very short list of "approved" general category and ontology terms. These terms are used to subdivide the entire collection of phenotypes by system, organ, or level of analysis. Some examples may help: "Central nervous system", "Immune system", "Metabolism", "Development", or "Urogenital system". Capitalize this list as you would a standard English sentence. Separate terms by commas and then end the terms with a colon. For example, "Central nervous system, pharmacology, endocrinology:" is a valid set of three terms. These terms do not really describe your trait, but are used by you and others to figure out how many traits there are in specific categories.

    Before making up your own terms, please review the current set of terms in GeneNetwork and find some terms/ontology categories that look good to you. If you have questions contact one of us on the GeneNetwork development team (rwilliams@uthsc.edu).
  2. After the colon start with your description of the phenotype you have generated. For example: "Ethanol response..." or "Anxiety assay...", "Brain weight...". The first letter should almost always be capitalized.
  3. Do not start with a generic uninformative word such as "Mean", "Maximum", "Left", "Right", "Count", "Number", "Difference", "Baseline", "Induction", "Decrease", "New", "Adjusted", "Distance", "Bilateral", "Time", "Total", "Percentage", "Percent". The reason is that the traits should in their default order be alphabetized and categorized in a conceptually useful way; not by something "dumb" like the "total" or "percent".
  4. Do not start with a specific instrumental assay such as "Morris water maze" or "Dowel test..." or "Porsolt test behavior". Many of these tests will be unknown to other users. Try to use a term that reflects the intent of the assay (Motor coordination test, Learning and memory assay, Allergic airway response). This may be difficult, particularly for tests such as the Porsolt swim test and the Morris water maze that measure aspects of many different traits (anxiety, activity level, spatial navigation, visual acuity etc). But in the interest of clarity of intent rather than precision of measurement, please follow this suggestion. The actual assay instrument can be listed after the primary and secondary trait descriptions.
  5. Many traits can be difficult to categorize in a consistent way. For example a trait such as "ventral midbrain copper level in males" could be labeled "copper level in the ventral midbrain." There is no right or wrong way to do this, but the convention should be to choose the order that you think will be most useful to other users in terms of comprehension and consistency with other existing phenotypes. Review related phenotypes before you start naming your own. You will find good and bad examples.
  6. Dose and route of drug delivery. If the phenotype is a pharmacological phenotype, whenever practical enter the doses and routes of injection in parentheses after the name of the general trait. For example, "Cocaine response (40 mg/kg ip)". We would prefer to use "ip" and "iv" rather than i.p. and i.v., but this is not a strong preference. If a protocol requires multiple treatments, please include them if possible. For example, "Cocaine response (3 x 3.2 mg/kg ip, Days 2, 3, 4),...").
  7. Series of more precise definitions of the phenotype and the subject(s) will often follow with commas used as separators. If possible make this understandable to almost any user, even at the risk of being wordy.

    For example, "Cocaine response (3 x 3.2 mg/kg ip, days 2, 3, and 4), conditioned place preference (CPP), change in time in cocaine-paired compartment relative to baseline (Day 5 minus Day 1) for 50 to 90-day-old males and females [sec]"

  8. Sex. If the data are for males please write out "in males" or "of male" or "for males". Do not just add a comma such as " , males" or "(M)". Definitely do not use hyphens "-males" since the hyphen can be confused for a minus sign. Sex and age should usually go toward the end of the description.
  9. Age and condition of subjects can be added if you think it is essential or helpful. However, do not bother with a generic addition "adult" since that is what most users will reasonably assume. If you would like to add an age range then use this format "in 100 to 200-day-old males and females" or "of 3 to 4-month-old males".
  10. Mandatory units of measurement between square brackets [min] or [sec] or [n bream breaks/10 min test]. If you are using an ordinal scale, then describe the scale within the brackets. If the units are simply a ratio or percentage then use [ratio] or [%].

Other advice on trait descriptions:

  1. Do Not Capitalize Each Word in a Description. (e.g, Ethanol Response, Distance traveled after saline - Distance traveled after ethanol for males and females [cm in a 0-5 min test period] )
  2. Do not use "-" as a minus sign. The dash is too confusing and may sometimes be used as a hyphen. Spell out "minus"
  3. No not use ALL CAP in a trait description (e.g., TOTAL)
  4. Do use commas when appropriate. For example, Morphine response severity of abdominal constriction for males needs a comma between "response" and "severity"
  5. Do not use extraneous words such as "time SPENT on rotarod". "time on rotarod" is good enough.
  6. Do not start with text or abbreviations that will not be understandable to all users, such as "RSS female and male..."
  7. Please use a space between a number and the units: Prepulse inhibition at 70 dB for females (not 70db). Please use the correct form of the abbreviation.
  8. Use American spelling.

By following these steps, you will help maintain the quality and usability of our phenotype data. Thank you for your cooperation!



Back to Index