Merge branch 'master' of https://github.com/solgenomics/sgn
[sgn.git] / cgi-bin / help / gene_search_help.pl
blob48de000f8b29c9e5cc608802c332463b055e9003
1 #!/usr/bin/perl
2 use strict;
3 use CXGN::Page;
4 my $page=CXGN::Page->new('');
5 $page->header('SGN: Gene search help');
7 print <<EOHTML;
9 <p>
10 The <a href="/search/direct_search.pl?search=loci">gene search</a> is a tool for searching genes in SGN's database.
11 These genes originate from various sources, including GenBank, PubMed literature mining, historic collections of gene names, and SGN user-contributed data.
12 </p>
14 <img src="/documents/help/screenshots/gene_search_help.png" alt="screenshot of gene search form" style="margin: auto; border: 1px solid black;" />
16 <h4>1. Simple search option: search by locus or allele name or symbol</h4>
17 <p>
18 Use this option for searching the database for genes with a locus or allele name/symbol/synonym/description containing what you typed in. You can search these fields for an exact match, begin with or end with your input, by selecting the desired option from the drop-down menu.
19 The search is case-insensitive.
22 </p>
25 <p>
26 <b>The following search options can be combined with the generic locus/allele search option. These are visible by clicking the \'Advanced search options\' button:</b>.
27 </p>
29 <h4>2. Organism</h4>
30 <p>
31 In this drop-down menu you will see a list of the common names of species that make up the collection of genes. You can use this optionfor limiting your search results to loci of only the organism you selected.
33 </p>
36 <h4>3. Chromosome</h4>
37 <p>
38 Choose a chromosome from this menu to limit results to loci mapped on that chromosome or linkage group.
41 </p>
43 <h4>4. Locus editor</h4>
44 <p>
45 Each locus in the genes database has an owner (either an SGN curator or a submitter). the owner also has certain edit privileges. You can search for loci owned by a specific <a href= "../search/direct_search.pl?search=directory">SGN user</a> by typing a first or a last name.
46 Anyone interested in obtaining an SGN user account may do so by <a href="../solpeople/new-account.pl">signing up for a new account</a>. After obtaining an SGN user account you may upload new loci to SGN\'s database.
47 If you are interested in obtaining editor privileges to a specific locus, please follow the link in the locus details page.
50 </p>
52 <h4>5. Annotation features</h4>
53 <p>
54 Use these checkboxes for narrowing your search to only genes with one or more of the following features:
55 <ul>
56 <li>Sequence: genes that have sequence annotation (GenBank ID and/or SGN unigene ID)</li>
57 <li>Marker: genes that correspond to a specific marker from SGN\'s <a href="../search/direct_search.pl?search=markers">marker database</a></li>
58 <li>GO/PO annotation: genes that are annotated to at least one <a href="http://geneontology.org">Gene Ontology</a> or <a href="http://plantontology.org">Plant Ontology</a> term</li>
60 </ul>
62 </p>
64 <h4>6. Phenotype</h4>
65 <p>
66 Some genes may have a phenotype description, either as an associated allele, or an associated phenotyped accession. This option will narrow the search results for only genes with a phenotype description containing the word or string you typed in.
67 For searching phenotypes of accessions not necessarily associated with a gene, you should use SGN\'s <a href="../search/direct_search.pl?search=phenotypes">phenotype search</a> page.
69 </p>
71 <h4>7. Ontology term</h4>
72 <p>
73 Use this box for searching for genes that are annotated to specific <a href="http://geneontology.org">Gene Ontology</a> or <a href="http://plantontology.org">Plant Ontology</a> terms. You may search for ontology annotations by typing any part of the ontology term ID, term name, term synonym, or term definition.
76 </p>
79 <h4>8. GenBank ID</h4>
80 <p>
81 Use this box for searching genes annotated to a specific GenBank ID. You may search using either a GI number or a GenBank accession.
84 </p>
87 EOHTML
90 $page->footer();