.. 5Jan2018 - The Sphinx help for KDSmart and KDXplore has a common topic for "KDXplore - KDSmart Data Exchange". This is achieved by the following: The images for this section are stored in commonimages/kdaps to avoid duplication. The topic in KDSmart/source/exchangedata-include.txt is where the topic really resides. This topic "exchangedata-include.txt" is included by ".. include:: ../../kdsmart/source/exchangedata-include.txt" in: KDXplore Topic "KDXplore-TrialManagement.rst" and KDSmart topic "exchangedata.rst". The treatment for topic levels is the include file needed them pushed down 1 level. KDSmart's "exchangedata.rst" has the original header and preliminary elements. .. include:: imagerefs.txt ======================== Trial Manager - Overview ======================== Trial Manager is a KDXplore plug-in that enables users to manage trials, traits, and tags. There are also tools for creating barcodes and connecting to the KDDart Database. Trial Manager can connect to KDSmart devices for data transfers, even without the access to internet. The purpose of this overview page is to outline some of the most important UI elements of Trial Manager. |br| Trial Manager Main Window ========================= The **Trial Manager Main Window** contains three main tabs for trials, traits, and tags. The image below is of the **KDXplore Main Window** and is opened to the **Trials Tab**. Each tab contains different tools for the management of data and the following sections will outline what can be done in each tab. |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager1.png :width: 100% :show_caption: True :alt: Trial Manager Main Window :title: Trial Manager Main Window (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager1.png :scale: 100 % :alt: Trial Manager Main Window Trial Manager Main Window |br| Trials Tab ---------- The **Trials Tab** contains all information for each trial in Trial Manager, along with tools for the management of these trials. The image and list below provides information on the most important elements of the **Trials Tab**: |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager2.png :width: 100% :show_caption: True :alt: Trials Tab :title: Trials Tab (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager2.png :scale: 100 % :alt: Trials Tab Trials Tab |br| .. list-table:: Main Elements of the Trials Tab :widths: 1 15 70 :header-rows: 1 * - Item - UI Element - Description * - |circle1| - |trials_btn| **Trials Tab** - Displays all trials currently in Trial Manager and provides tools to manage these trials. * - |circle2| - **Trials Panel** - Lists the trials available within Trial Manager. Selecting a trial in this panel will display its information in the other panels. * - |circle3| - **Trial Details Panel** - Displays trial details for the selected trial. * - |circle4| - **Uses Traits Panel** - Lists the traits that are used in the selected trial. * - |circle5| - **Measurements Panel** - Lists the measurements in the trial by the source i.e. which KDSmart device was used to take the trait measurements. |br| Trials Panel ~~~~~~~~~~~~ The **Trials Panel** is the primary interface for managing trials in Trial Manager. It lists all trials currently available in KDXplore, and provides options for importing, editing, organising, and deleting trials. |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager5.png :width: 70% :show_caption: True :alt: Trials Panel :title: Trials Panel (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager5.png :scale: 70 % :alt: Trials Panel Trials Panel |br| .. list-table:: UI Elements of the Trials Panel :widths: 20 70 :header-rows: 1 * - UI Element - Description * - |trials_btn| **Trials Tab** - This tab being highlighted indicates that it is currently selected. * - |import_btn| **Import Button** - Provides options for importing new trials. * - |add_btn| **Add Button** - Create a new trial or trial bundle. * - |edit_btn| **Edit Bundle Button** - Edit any selected trial bundle including adding or removing trials from that bundle. * - |delete_btn| **Delete Button** - Delete trials from KDXplore and *shift-click* to delete the trial's traits as well. Please note that trials imported from KDDart will not be deleted from the online database but only from KDXplore's offline database. * - |filter_btn| **Filter Button** - Opens a search field where text can be entered to filter trials. * - |trial_grp_btn| **Trial Grouping Button** - Provides grouping options to organise trials. |br| Trial Details Panel ~~~~~~~~~~~~~~~~~~~ Trial details are presented when a trial in the **Trials Panel** is selected. The details that are presented will be different depending on the source of the trial such as from the KDDart Database, a local file, or from KDSmart. |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager6.png :width: 70% :show_caption: True :alt: Trial Details of a Trial from KDSmart :title: Trial Details of a Trial from KDSmart (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager6.png :scale: 70 % :alt: Trial Details of a Trial from KDSmart Trial Details of a Trial from KDSmart |br| |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager7.png :width: 70% :show_caption: True :alt: Trial Details of a Trial from KDDart :title: Trial Details of a Trial from KDDart (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager7.png :scale: 70 % :alt: Trial Details of a Trial from KDDart Trial Details of a Trial from KDDart |br| .. list-table:: UI Elements of the Trial Details Panel :widths: 20 70 :header-rows: 1 * - UI Element - Description * - |trial_info_btn| **Trial Info Button** - Refreshes trial information from KDDart. * - |seed_btn| **Seed Button** - Opens the **Seed Preparation Wizard** for preparing seeds for planting. * - |edit_btn| **Edit Current Trial Button** - Opens the **Curation Window** to curate data collected for the trial. * - |upload_btn| **Upload Button** - Upload the trial to KDDart. * - |harvest_btn| **Harvest Button** - Opens the **Harvest Wizard** for harvesting specimens. * - |barcode_btn| **Barcode Button** - Provides options to generate barcodes and download them in CSVs. These CSV files are used to generate scannable barcodes for plots, sub-plots, and traits. * - **Edit Button** - This button has no icon but is the disabled button in the top-right corner of the above two images. It allows users to edit some values of the trial details such as the trial name or planting date. If the value in the attribute column in blue then the value in that row is editable in KDXplore. .. note:: Please note that the **Seed Preparation Wizard** and the **Harvest Wizard** are still in an alpha state. |br| Uses Traits Panel ~~~~~~~~~~~~~~~~~~ The **Uses Traits Panel** lists the traits within a selected trial and further information on each trait including the trait descriptions and data validation rules. |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager8.png :width: 70% :show_caption: True :alt: Uses Traits Panel :title: Uses Traits Panel (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager8.png :scale: 70 % :alt: Uses Traits Panel Uses Traits Panel |br| .. list-table:: UI Elements of the Uses Traits Panel :widths: 20 70 :header-rows: 1 * - UI Element - Description * - |trait_order_btn| **Trait Order Button** - Opens the **Change Scoring Order Window** where users can choose the order that these traits are scored in the field. * - |add_btn| **Add Traits Button** - Opens the **Add Traits Window** where any available traits on KDXplore can be added to the trial. * - |minus_gold_btn| **Remove Traits Button** - Removes the selected trait from the trial. Multiple traits can be selected for removal at the same time. * - |refresh_btn| **Refresh Button** - Refreshes trait and trial data of the trial. |br| .. _measurements_panel: Measurements Panel ~~~~~~~~~~~~~~~~~~ The **Measurements Panel** provides information on the collected samples of a trial. The example of the image below contains three sets of samples: the *Curated Column* with a fraction and percentage of the plots that have been curated for that trait; the *For Scoring Column* is a scoring set that has been created for export to KDSmart; and the *Galaxy S6 Column* is the scored samples that have been imported from KDSmart. Both traits (rows) and datasets (columns) can be selected for further actions such as in the example below. |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager9.png :width: 70% :show_caption: True :alt: Measurements Panel :title: Measurements Panel (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager9.png :scale: 70 % :alt: Measurements Panel Measurements Panel |br| .. list-table:: UI Elements of the Measurements Panel :widths: 20 70 :header-rows: 1 * - UI Element - Description * - |minus_gold_btn| **Remove Traits Button** - Remove any selected traits from the trial. * - |export_btn| **Export Button** - Opens the **Export Samples Window** to export the selected samples or traits for a trial. Any scoring set can be exported to KDSmart for scoring. * - |add_btn| **Add Scoring Set Button** - Choose traits to create a scoring set. * - |delete_btn| **Delete Collected Samples Button** - Delete collected samples (the selected column). |br| Traits Tab ---------- The **Traits Tab** contains all information for each trait in Trial Manager, along with tools for the management of these traits. The image and list below provides information on the most important elements of the **Traits Tab**: |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager3.png :width: 100% :show_caption: True :alt: Traits Tab :title: Traits Tab (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager3.png :scale: 100% :alt: Traits Tab Traits Tab |br| .. list-table:: Main Elements of the Traits Tab :widths: 1 15 70 :header-rows: 1 * - Item - UI Element - Description * - |circle1| - |traits_btn| **Traits Tab** - Displays all traits currently in Trial Manager and provides tools to manage these traits. * - |circle2| - **Traits Panel** - Lists the traits and trait bundles available in Trial Manager. * - |circle3| - **Used by Trials Panel** - Lists all of the trials that contain the selected trait. * - |circle4| - **Details Panel** - Lists the details of the currently selected trait including the trait name, alias, and level (plot or sub-plot level). |br| Traits Panel ~~~~~~~~~~~~ The **Traits Panel** is the primary interface for managing traits in Trial Manager. It lists all traits currently available in KDXplore, and provides options for importing, editing, organising, and deleting traits. |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager10.png :width: 70% :show_caption: True :alt: Traits Panel :title: Traits Panel (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager10.png :scale: 70% :alt: Traits Panel Traits Panel |br| .. list-table:: UI Elements of the Traits Panel :widths: 20 70 :header-rows: 1 * - UI Element - Description * - |traits_btn| **Traits Tab** - This tab being highlighted indicated that it is currently selected * - |import_btn| **Import Button** - Provides options for importing new traits. * - |barcode_btn| **Barcode Button** - Provides options for generating and printing barcodes * - |add_btn| **Add Button** - Create a new trait or trait bundle. * - |edit_btn| **Edit Bundle Button** - Edit any selected trait bundle including adding or removing traits from that bundle. * - |upload_btn| **Upload Button** - Upload the trait to KDDart. * - |export_btn| **Export Button** - Export selected traits to a CSV file. A window will open which will provide these options. * - |lock_btn| **Lock Button** - Locks and unlocks editing for traits. Locking traits ensures that they cannot be changed after being used. * - |refresh_btn| **Refresh Button** - Refreshes any changes made to trait data. * - |filter_btn| **Filter Button** - Opens a search field where text can be entered to filter traits. * - |delete_btn| **Delete Button** - Delete traits or trait bundles from KDXplore. |br| Used by Trials Panel ~~~~~~~~~~~~~~~~~~~~ The **Used by Trials Panel** displays the trial names that any selected trait is used in, along with the trial acronyms and planting date. |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager11.png :width: 70% :show_caption: True :alt: Used by Trials Panel :title: Used by Trials Panel (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager11.png :scale: 70% :alt: Used by Trials Panel Used by Trials Panel |br| |br| Details Panel ~~~~~~~~~~~~~ The **Details Panel** lists the details of the currently selected trait including the trait name, alias, and level (plot or sub-plot level). |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager13.png :width: 50% :show_caption: True :alt: Details Panel :title: Details Panel (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager13.png :scale: 50% :alt: Details Panel Details Panel |br| .. list-table:: UI Elements of the Details Panel :widths: 20 70 :header-rows: 1 * - UI Element - Description * - |undo_btn| **Undo Button** - Undoes any changes made to the selected trait. This will be disabled if not applicable. * - |redo_btn| **Redo Button** - Redoes any undo action made on a selected trait. This will be disabled if not applicable. Any attribute that is in blue can be edited if editing is unlocked. *Double-click* a value to open the **Edit Trait Properties Window** as seen in the image below. Values can be edited and then saved with the **Save Button**. |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager12.png :width: 50% :show_caption: True :alt: Edit Trait Properties Window :title: Edit Trait Properties Window (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager12.png :scale: 50% :alt: Edit Trait Properties Window Edit Trait Properties Window |br| Tags Tab -------- The **Tags Tab** contains all information for each tag in Trial Manager, along with tools for the management of these tags. The image and list below provides information on the most important elements of the **Tags Tab**: |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager4.png :width: 100% :show_caption: True :alt: Tags Tab :title: Tags Tab (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager4.png :scale: 100% :alt: Tags Tab Tags Tab |br| .. list-table:: Main Elements of the Tags Tab :widths: 1 15 70 :header-rows: 1 * - Item - UI Element - Description * - |circle1| - |tags_btn| **Tags Tab** - Displays all tags currently in Trial Manager and provides tools to manage these tags. * - |circle2| - **Tags Panel** - Lists the tags and tag bundles available in Trial Manager. * - |circle3| - **Details Panel** - Lists the details of the selected tags. |br| Tags Panel ~~~~~~~~~~ The **Tags Panel** is the primary interface for managing tags in Trial Manager. It lists all tags currently available in KDXplore, and provides options for importing, editing, organising, and deleting tags. |br| .. only:: html |center-start| .. thumbnail:: images/TrialManager/TrialManager14.png :width: 70% :show_caption: True :alt: Tags Panel :title: Tags Panel (select to zoom) |center-end| .. only:: latex .. figure:: images/TrialManager/TrialManager14.png :scale: 70% :alt: Tags Panel Tags Panel |br| .. list-table:: UI Elements of the Tags Panel :widths: 20 70 :header-rows: 1 * - UI Element - Description * - |tags_btn| **Tags Tab** - This tab being highlighted indicated that it is currently selected * - |import_btn| **Import Button** - Provides options for importing new tags. * - |add_btn| **Add Button** - Create a new tag or tag bundle. * - |edit_btn| **Edit Bundle Button** - Edit any selected tag bundle including adding or removing tags from that bundle. * - |upload_btn| **Upload Button** - Upload the trait to KDDart. * - |export_btn| **Export Button** - Export selected tags to a CSV file. A window will open which will provide these options. * - |filter_btn| **Filter Button** - Opens a search field where text can be entered to filter tags. * - |delete_btn| **Delete Button** - Delete tags or tag bundles from KDXplore. |br|