docs/01_basic_website_usage.md

   1 ---
   2 title: "1. Basic Website Usage"
   3 layout: doc_page
   4 ---
   5
   6 <!-- TOC-START -->
   7 * TOC
   8 {:toc}
   9 <!-- TOC-END -->
  10
  11 1.1. Creating a User Account
  12 ---
  13
  14 ### Verifying first that you do not already have an account
  15
  16 Before creating an account, please verify first that you don’t already have an account. You can use “Search” menu to check if you already registered as a user.
  17
  18 In the "Search" menu, selecting the "People" tab and search your name. If nothing is found, proceed with the instructions below. Otherwise, clicking the “Login” button. If you have forgotten your password, you can retrieve it by clicking the "Forgot your password?" link on the login page.
  19
  20 ### Creating a user account
  21
  22 On the right of the toolbar, clicking on “Login.” It will take you to the login page. On the login page, clicking on the link “sign up for an account.” It will take you to the page below:
  23
  24 <img src='{{"assets/images/image331.png" | relative_url }}' width="624" height="499" />
  25
  26 Filling in all of the information, then clicking "Create Account."
  27
  28 After you submit the information, an email will be sent to the provided email address. Checking your email and clicking on the link to activate your account.
  29
  30 1.2. Managing your Account {#managing-your-account}
  31 --------------------------
  32
  33 ### Login
  34
  35 To login, clicking the "Login" link in the toolbar on any page and enter your username and password.
  36
  37 If you have forgotten your password, you can retrieve it by clicking the "Forgot your password?" link on the login page.
  38
  39 <img src='{{"assets/images/image166.png" | relative_url }}' alt="login.png" width="624" height="133" />
  40
  41 ### Editing Account Settings
  42
  43 Account settings can be edited by clicking on the "my profile" link displayed as your user name, on the right of the toolbar. You must login, in order to access and change account settings.
  44
  45 <img src='{{"assets/images/image261.png" | relative_url }}' alt="login1.png" width="624" height="228" />
  46
  47 You can add personal information to your account using the "View or update personal information" link.
  48
  49 To change your password, username, or your contact email, clicking on “Update account information” link. You must provide your old password before you can make any changes.
  50
  51 <img src='{{"assets/images/image144.png" | relative_url }}' alt="login2.png" width="624" height="302" />
  52
  53 ### Changing Your Account Status: From “User” to “Submitter”
  54
  55 After you create an account, your account has a "user" status. This account has limited privileges.
  56
  57 Accounts with “user” status are able to:
  58
  59 -   Change personal information
  60 -   Post comments on pages
  61 -   Post to the forum
  62
  63 To upgrade your account status to "submitter,” contact the database curators using the "contact" link provided at the footer of each page. Submitter accounts can add data, such as new plots, accessions, phenotype data and images.
  64
  65 ### Submitting Feedback on an SGN Database
  66
  67 We appreciate your feedback! Feel free to submit any questions or suggestions by using the "Feedback" link provided at the footer of each page.
  68
  69 1.3. Menu Layout
  70 ----------------
  71
  72 SGN Database websites have a toolbar on the top of each page with a number of menus for convenient access of major functions. The menus, as pictured below, are “search,” “manage,” “analyze,” and “maps.” The toolbar also provides a quick search, a “log in” button, and a “new user” button.
  73
  74 <img src='{{"assets/images/image270.png" | relative_url }}' width="624" height="33" />
  75
  76 ### Menu Options
  77
  78 #### Search
  79
  80 In the Search menu, the options are:
  81
  82 | Tab                   | Description                                                                                                                            |
  83 |-----------------------|----------------------------------------------------------------------------------------------------------------------------------------|
  84 | Wizard                | Search different accessions and plots by location, year, trial, and trait data. Can also be used to create lists of different types.   |
  85 | Accession and plots   | Search accessions and plots using a variety of criteria                                                                                |
  86 | Trials                | Search trials by name, description, breeding program, year, location, and trial type.                                                  |
  87 | Markers               | Search different markers                                                                                                               |
  88 | Images                | Search images contained in the SGN database                                                                                            |
  89 | People                | Search database users                                                                                                               |
  90
  91 #### Manage
  92
  93 In the Manage menu, the options are:
  94
  95 | Tab                 | Description                                                                                        |
  96 |---------------------|----------------------------------------------------------------------------------------------------|
  97 | Breeding Programs   | View, add and delete breeding programs                                                             |
  98 | Locations           | View, add and delete locations                                                                     |
  99 | Accessions          | Manage and search different accessions                                                             |
 100 | Seedlots            | Manage and search different seedlots                                                               |
 101 | Crosses             | Create new crosses in the database                                                                 |
 102 | Field Trials        | Manage field trials. Create trials using different field layouts.                                  |
 103 | Genotyping Plates   | Manage genotyping plates. Create 96 or 384 well plates.                                            |
 104 | Phenotyping         | Upload phenotyping files from the Tablet Field Book application                                    |
 105 | Field Book App      | Manage the field book app data (download files to tablet)                                          |
 106 | Barcodes            | Refers to the old barcode system, mainly historical                                                |
 107 | Download            | Download information in the database based on lists                                                |
 108
 109 #### Analyze
 110
 111 **Clicking on the "Analyze" link will give a full menu of all analysis functions**
 112 In the Analyze menu, the options are:
 113
 114 | Tab                   | Description                                                                             |
 115 | --------------------- | --------------------------------------------------------------------------------------- |
 116 | **Breeder Tools**     |                                                                                         |
 117 | Breeder Home          | Access breeding functionalities. Lists important and helpful links.                     |
 118 | Barcode Tools         | Manage, create, and download barcodes. Also access barcode tools.                       |
 119 | Genomic Selection     | Can search for traits, start building a GS model, and predict values based on genotypes |
 120 | **Sequence Analysis** |                                                                                         |
 121 | BLAST                 | Sequence homology search                                                                |
 122 | **Other**             |                                                                                         |
 123 | Ontology Browser      | Browse all recorded ontologies                                                          |
 124
 125 1.4. Working with Lists {#working-with-lists}
 126 -----------------------
 127
 128 Lists are collections of identifiers that are stored in the database. Lists can be composed of accessions, plots, traits, locations, and trials. Lists are attached to the individual user's account, and can only be created and seen by the user while logged in. SGN databases make heavy use of lists in a number of tools on the website. For example, trials are created using lists of accessions.
 129
 130 ### Creating lists
 131
 132 Lists can be generated in various ways:
 133
 134 One way to create a list is by clicking on the "Lists" link located on the toolbar.
 135
 136 <img src='{{"assets/images/list_manager_start.png" | relative_url }}' />
 137
 138 To create a new list, enter the name of your new list and then clicking on the “New List” button. The name of the list can be anything, but should be unique and should be something to help you easily identify.
 139
 140 <img src='{{"assets/images/list_manager_new_list.png" | relative_url }}' />
 141
 142 You can find the list that you entered on the “Your Lists” page. To add items to your list, click on the "View" icon to open “List Contents” page.
 143
 144 <img src='{{"assets/images/list_manager_view_list.png" | relative_url }}' />
 145
 146 On the “List Contents” page, enter items that you want to add to the list, then click on “Add” button.
 147
 148 <img src='{{"assets/images/list_manager_add_items.png" | relative_url }}' />
 149
 150 The page will be updated and will display your items in a table at the bottom of the page. It is possible to sort the list if you need.
 151
 152 <img src='{{"assets/images/list_manager_added_items.png" | relative_url }}' />
 153
 154 Select the type of items in your list. To verify that the items that you added to your list are already stored in the database and that you selected a correct type for the items, click on the “Validate” button.
 155
 156 <img src='{{"assets/images/list_manager_list_types.png" | relative_url }}' />
 157
 158 If those items are already in the database, a message will indicate that “This list passed validation”
 159
 160 <img src='{{"assets/images/image346.png" | relative_url }}' alt="list9.png" width="523" height="111" />
 161
 162 Note that a list cannot contain duplicate elements. If a duplicate item is entered, the list manager will inform the user that the element is already in the list and will not add it again.
 163
 164 Another easy way to create a list is to use the [*Search Wizard*]({{ site.baseurl }}{% link 02_searching_the_database.md %}#search-wizard), which can be accessed from the Search menu.
 165
 166 ### Viewing and editing lists
 167
 168 Lists can be viewed and edited using the "Lists" link on the toolbar. Clicking on the link will open a window that displays all of your lists, as well as an option to create new lists.
 169
 170 <img src='{{"assets/images/image71.png" | relative_url }}' alt="list8.png" width="624" height="196" />
 171
 172 This page shows all lists that have been created, including those created by using the Search Wizard. You can view and edit your lists by using “Actions” buttons.
 173
 174 1. Clicking on the "view" icon will open a new window called "List Contents" that allows you to change the list name, the type of the list, add new items, or delete existing items.
 175
 176 2. Clicking on the “delete” icon will delete your list. **Caution: this action cannot be undone**.
 177
 178 3. Clicking on the “download” icon will download the contents of your list to your computer.
 179
 180 4. Clicking on the “make public” icon will make your list available for other users to view and use your list.
 181
 182 <img src='{{"assets/images/image297.png" | relative_url }}' alt="list10.png" width="624" height="97" />
 183
 184
 185 1.5. User Permissions
 186 ---
 187
 188 Users are assigned into four different groups to determine the level of access they have on the database. This is to prevent data from being altered of deleted in error.
 189 Users are also assigned under Breeding Programs to restrict data access between different breeding programs.
 190 Curators can go to Manage User Roles to see user permissions and change a user's permission level.