KnowPulse-KnowledgeBase / helium-exporter

How do I visualize pedigree with helium pedigree visualization application?
https://knowpulse-knowledgebase.github.io/helium-exporter/
Creative Commons Zero v1.0 Universal
0 stars 0 forks source link

Episode 1 and 2 are ready for review while episode 3 still needs some help #1

Open ruobinLiu opened 2 years ago

reynoldtan commented 2 years ago

Hi Ruobin here are my revisions to Episode 1 and 2 for your review.

E I

**When you land on KnowPulse homepage, scroll down to the data section and click on the Export to Helium to access the Helium Exporter.

When you land on KnowPulse homepage, scroll down to the Data section and click on the Export to Helium link under Phenotypic Data panel to access the Helium Data Exporter (please see image below). Alternatively, you can navigate to the Helium Data Exporter page directly by typing the address knowpulse.usask.ca/helium-exporter onto your browser's address bar.

**To use Helium Data Exporter, you will first need to install Helium Viewer Application on your local computer. You will find the setup guide on the Helium Exporter page guiding you through the process of application installation. Please use the link to select the operating system to download and install Helium

To visualize pedigree and categorical data generated by Helium Data Exporter, you will first need to install Helium Pedigree Visualization Application on your local computer. Helium Data Exporter interface contains a graphical setup guide to assist you through the process of installing Helium. In addition, all pertinent links to get you started are also outlined in the guide, including links to download a Helium version that is compatible to your operating system (OS) in use.

**P.S. For Mac users, Apple will resist since Helium is not in Apple store and they will not guarantee it safe, just click ctrl+click the open button when you are prompted.

Please note for Mac OS user that your system will notify you upon installation about potential safety issue since Helium is not obtained through Apple store. This can be bypassed by pressing CTR key when clicking Open button (install) when prompted.

** Image This image shows the top section of Helium Data Exporter interface showing a brief summary of Helium Pedigree Visualization and a graphical quick step by step guide on how to visialize pedigree and categorical data using Helium.

E II

**Pedigree and categorical data from your registered experiment(s) can be downloaded from Helium Exporter module(requires login to access).

Users can export pedigree and categorical data using Helium Data Exporter for visualization using Helium in the following steps.

Please note that you can only export data from experiments that you have permission to. Other experiments that you wish to download data from can be arranged by contacting KnowPulse.

This guide assumes that you have obtained a copy of Helium that matches your operating system and that you have correctly installed the software in your computer. Please see EI (Helium setup guide)

STEP 1

**Select an experiment of your interest from the Experiment selector. (You have to be the user of an experiment before you can access any data under it, talk to us if you have any permission issue).

Select an experiment of interest from the Experiment selector dropdown field. Experiments shown in this field are only the experiments assigned to your account in KnowPulse. Please contact us to gain permission to other experiments available in KnowPulse.

When an experiment is selected, germplasm and trait fields repopulate with experiment-specific germplasm and trait options that you can select.

STEP 2

** Then choose the germplasm of your interest from Germplasm/lines selector with search functionality. From here, on your left hand side, checkboxes allow you to choose the desired germplasm. Germplasm field supports an inline search for specific germplasm.

Select or deselect GERMPLASM by clicking the checkbox for each option. Use inline field controls to search specific option or to select/deselect all options.

STEP 3

** Followed by the germplasm section is the Trait/categorical data selector with search functionality. Again, on your left hand side, there is a trait search field that supports inline search for any traits of interest. On your right hand side, in the field control, you can either use Search to look up a specific trait from the field, or click on All to select all the available traits.

Select or deselect TRAIT by clicking the checkbox for each option. Use inline field controls to search specific option or to select/deselect all options.

IMAGE - FORM This is a screenshot of Helium Data Exporter form field elements showing 50 germplasms available with the 27 out 50 lines selected (checked). On the right hand side of each field, are field controls search and select/deselect all checkbox. You can use Search to look up for specific germplasm from the field and click on All to select the full dataset.

STEP 4 ** Below the Trait, there is an additional filter called Parental Relationships Only. Click on it allows you to choose only the maternal and parental relationships of the germplasm, therefore, only male and female parents of a line are returned.

Select germplasm relationship type to return by checking Parental Relationships Only checkbox. This is field is unchecked by default and will return all germplasm relationthips types (ie. line is a selection of, line is a cultivar of etc.) in addition to parental relationships (Male and Female parents of a line). By checking this option, only parental relationships of a line will be returned.

STEP 5 ** Finally, click on the Download button to submit your request.

Click Download button to submit your request. The exporter will gather all datapoints that matched your criteria and will generate the required data files.

DOWNLOAD

** Helium from there will return you two tab-separated-value files, with the extension name of .helium. One is for pedigree data, the other is for categorical data. It may take the exporter a few seconds to generate the files for you. Those two files can be saved onto your local computer, followed by loaded to Helium for visualization. We will talk more visualization details in the next episode.

Helim Data Exporter will generate two tab-separated-value files namely, pedigree data file and categorical data file. Each data file will have .helium extension to correspond the file to Helium Pedigree Visulaization program in your computer. Both files are generated simultaneously with progress being reported to user by a graphical progress bar. These two data files can be saved when enabled onto your local computer and can be loaded to Helium for visualization.

We will talk more visualization details in the next episode.