Merge pull request #4106 from solgenomics/topic/wishlist
[sgn.git] / mason / phenotypes / submission_guide.mas
blob9d3948ce5a30a73587c22cc9d22d661dbdf0623a
1 <%doc>
3 =head1 NAME
5 submission_guide.mas sgn phenotyping experiment data submission guidelines
7 =AUTHOR
9 Naama Menda (nm249@cornell.edu)
11 =cut
13 </%doc>
14 <h2>SGN phenotype submission guide</h2>
15 <p>For submitting phenotyping experiments to SGN you will be asked to fill in a few steps.
16 Phenotypes are linked with plant accessions.
17 If the accession is already in the database, you will have to make sure the accession in your file has exactly the same name.
18 Search the <a href="/search/stocks/">phenotype database</a> for existing accessions.
19 Since phenotypes are scored on single plants in the field or a greenhouse, or on plots of several plants,
20 you will need to assign in each experiment unique identifiers for each one of your experimental units (a single plant or a plot).
21 </p>
23 <&| /page/info_section.mas,
24    title      => "Define experiment metadata",
25   collapsible => 1,
26   collapsed   => 0
29 <ul>
30   <li>
31     <strong>Organism name:</strong> Start typing the species scientific name. An autocomplete list should pop up. If your organism is not in the list, please <a href="mailto:sgn-feedback@solgenomics.net">contact us</a>.
32   </li>
33   <li>
34     <strong>Population name</strong><br />
35     Provide a name for the population in this experiment. Your population may or may not have a known structure, and its name can be arbitrary. If you are adding accessions to an existing population, start typing its name and select the appropriate one from the autocomplete list.
36   </li>
37   <li>
38     <strong> Population description</strong><br />
39     (optional) provide an abstract style characterization of the population including experimental design highlights.
40    </li>
41   <li>
42     <strong> Project name</strong></br >
43     provide a name for your project which reflects the scope of your phenotyping experiments. For adding experiments to an existing projects, start typing and select the appropriate project name for the autocomplete list.
44   </li>
45   <li>
46     <strong> Year</strong><br />
47     Date string denoting when the data was collected. Can be year only (i.e. 2012), month and year (March 2012 or 3/2012), or a full date. This will be recorded as the date for the project.
48   </li>
49   <li>
50     <strong> Location</strong><br />
51     Where the experiment was performed. We also support <a href="http://en.wikipedia.org/wiki/WGS84">WGS84 geodetic datum</a>. For a full geolocation fill in the longitude, latitide, and altitude fields.
52   </li>
53   </ul>
54 </&>
56 <&| /page/info_section.mas,
57     title      => "Upload phenotyping data file",
58   collapsible => 1,
59   collapsed   => 0
61 <ul>
62   <li><strong>Format</strong><br />
63     Save your data file in tab-delimited format. Make sure there is only one column header row. Both row and column headers should be unique. You can save your spreadsheet as text, and choose tab-delimited format (tab-delimited text in MS Excel).
64   </li>
65   <li><strong>Row headers</strong><br />
66     First column has the row headers. These must be unique. It can be the accession name or number only if you have one row of measurements for each.<br />
67     If you have more than one row of data for each accession (e.g. several repeats or plots of the same accession) then row headers could be just incremented row numbers.
68   <li>
69   <li><strong>Accession name column</strong><br />
70     Second column should be names of the plant accessions - this will be loaded literally into the database. If the accession already exists in SGN, please make sure to use exactly the same name (case insensitive, but spaces, hyphens, and other special characters are important).
71   </li>
72   <li><strong>Plot names or numbers</strong><br />
73     Usually phenotping data is assayed on plants in plots. We load each plot as subject of the plant accession, meaning any number of plots from any number of different experiments can be loaded, allowing to keep track of when and where the data came from. If you have multiple phenotyping repeats for each plots, write each in a new row. If only some of the traits were score in each phenotyping repeat, keep those cells empty (do not write 0, since it will be loaded as a measurement with a value of zero).
74   <li><strong>Repeat number</strong> (optional)<br />
75     If you have multiple repeats, the loading software will automatically increment the repeat number each time it sees a row of data for a plot or accession. If you provide repeat number (or fruit/plant/leaf number etc.) it will be used instead.
76   </li>
77   <li><strong>Traits</strong><br />
78     following columns should have trait scored values. Headers should be ontology IDs. These terms <b>must</b> be pre-loaded in the database (e.g. the  <a href="http://solgenomics.net/search/phenotypes/traits">Solanaceae Phenotype Ontology</a> ). If your ontology does not exist in the database, or if you have terms that need to be added to an existing ontology,<a href="mailto:sgn-feedback@solgenomics.net"> contact us</a> first.<br />
79     Units may also be attached to ontology IDs using a pipe ("|") followed by "unit:unit_name" (e.g. SP:0000123|unit:cm). Number of data columns is unlimited.
81     <pre>
82       row_header   accession  plot  repeat  SP:0000085|unit:cm^2  SP:0000086|unit:cm   SP:0000106
83       1            stock1     100    1       5                    9                   8
84       2            stock1     101    1       4                    8.5                 3
85       3            stock1     101    2       5                    7.4                 12
86       4            stock2     102    1       5.5                  7.7                 10
88     </pre>
89 </ul>
91 <h3><a href="/phenotype/upload">Upload phenotyping data</a></h3>
93 </&>