* What can do Cov-HiPathia for you
* How to use Cov-HiPathia:
* Tools:
* Worked examples:
* For further learning:
* What can do Cov-HiPathia for you
* How to use Cov-HiPathia:
* Tools:
* Worked examples:
* For further learning:
This is an old revision of the document!
====== Prediction ====== The aim of the //Prediction// tool is to take advantage of the signalling circuit activities to distinguish between phenotypes. Depending on the study design, we can perform a two group comparison or a correlation with a continuous variable. HiPathia Prediction uses the signalling value of mechanism-based biomarkers to compute a SVM prediction model with cross-validation. Moreover, previously obtained models could be used to predict the phenotype of new samples. The tool can be accessed from the main menu bar, by clicking on the //Prediction// button, see [[workflow|Workflow]] for further information. {{ :prediction_form.png?nolink |}} ===== Prediction form ===== The main page of a the tool is its filling in form. This form includes all the information and parameters that the tool needs to process a study. The form is divided in different panels: ==== Type panel ==== The type panel allows you to choose the kind of prediction analysis you want to perform. You can choose between two options: * **Train new model**: A prediction model is generated with your selected data. {{ ::typepanel.png?nolink |}} * **Test existing model**: You can choose an already trained model to predict the phenotype of new samples. Existing prediction models can be selected from your project folders stored in HiPathia's server. {{ ::typetestpanel.png?nolink |}} ==== Input data panel ==== In the input data panel, we must introduce the expression data. {{ :differential_signaling_input.png?nolink |}} The **expression data** has to be: * Expression matrix provided by ourselves (see how to upload files in [[upload_your_data|Upload your data]]). ==== Design data panel ==== The design data panel allows you to choose the kind of experiment you want to perform. You can choose between two kinds of experimental design: * **Two group comparison**: The comparison is performed between the two groups described in the experimental design file.\\ The experimental design file must include **two columns**: the first one with the names of the samples, the second one with the class to which each sample belongs. {{ ::designdatacomp.png?nolink |}} If the experimental design file contains more than two classes then you have to select the appropriate class for each condition.\\ **Note:** the condition 2 will be taken as a reference condition. {{ ::morethantwoclass.png?nolink |}} * **Correlation with continuous variable**: A correlation is performed between the values of each effector circuit along the samples and the continuous variable introduced.\\ The experimental design file must include **two columns**: the first one with the names of the samples, the second one with the value of the variable for each one of the samples. {{ ::designdatacorr.png?nolink |}} ==== Species ==== Here we must choose the species of our experiment. You can choose among: * Human (Homo sapiens) * Mouse (Mus musculus) * Rat (Rattus norvegicus). {{ ::species.png?nolink |}} ==== Parameters ==== This panel includes further parameters necessary to run an analysis. **Filter circuits**: Check to obtain the circuits that best differentiate your phenotype. This option is only available from //Prediction// tool. {{ ::filtercircuits.png?nolink |}} ==== Pathways ==== This panel includes the list of all available pathways in HiPathia. We can select the pathways with which the analysis will be performed.\\ HiPathia retrieves pathway information from [[https://www.kegg.jp/kegg/pathway.html|KEGG database]]. KEGG pathway database is a collection of manually drawn pathway maps representing the knowledge on the molecular interaction, reaction and relation networks. {{ :pathways.png?nolink |}} By default all available pathways are selected.\\ **Note:** At least one pathway has to be selected. ==== Study information ==== This panel includes some parameters in order to identify and save our study. * **Output folder**: If we want to reorganize our studies we can select the folder in which we want save our report. By default the study will be saved in the home in a folder named "Prediction_train_study-N" if it is a training analysis or "Prediction_test_study-N" if it is a prediction test analysis, N is an integer number. * **Study name**: We can give a name to our study. This is very useful to later identify it among the other studies listed in the //My studies// list.\\ The default study name is "Prediction_train_study-N" or Prediction_test_study-N", N is an integer number. * **Description**: We can give a description to our study. {{ ::studyinfopredform.png?nolink |}} ==== Run analysis ==== Once the form has been filled in, press the //Run analysis// button to launch the study. {{ ::runanalysis.png?nolink |}} Your study will be listed in the //My studies// panel, and a panel called //Browse my studies// will appear showing all your studies and their state. the new study will appear with a **queued** state then **running** state. If everything goes well, the state will be **done** after few minutes(depending on the inputs data and the availability of server). All study states are: * **Queued**: The information has been processed and the study has been sent and waits to be processed. * **Running**: The study is in progress, study can be cancelled using the stop button. {{ ::runningpredstudy.png?nolink |}} * **Done**: The study has ended and the results are available to visualize and download. * **Cancelled**: The study was canceled before finishing. * **Error**: Sometimes a study can stop returning a error message, you can report and contact us in order to help you to fix it.{{ ::errorexample.png?nolink |}} {{ ::mystudiespredict.png?nolink |}} ===== Prediction report ===== The report page of the Prediction tool includes different output results. You can download any table or image showed in the results page by clicking on the name right before it. You can also download the pathway and function matrices by clicking on //Circuit values//. The results are divided in different panels: ==== Study Information ==== Here you can find the information about the selected study. {{ ::studyinfopredreport.png?nolink |}} * **Name**: the study name. * **Description**: the description of the current study. * **Tool**: the name of the used tool (in this case, is Hipathia). * **Date**: study's launching date (MM/DD/AAAA, HH:MM:SS AM/PM format) ==== Input Parameters ==== Here you can visualize the parameters with which the current study was launched. {{ ::inputpredictreport.png?nolink |}} * **Expression file**: The name of the expression file that has been used in the current study. * **Design file**: The name of the design file that has been used in the current study. * **Comparison**: The groups that have been compared, for example; Normal vs Tumor. * **Paired analysis**: Have the input data been paired? **No** or **Yes**. * **Species**: The species of this experiment; Human (Homo sapiens),Mouse (Mus musculus) or Rat (Rattus norvegicus). ==== Circuit values ==== You can download the matrix of circuit activity values by clicking on circuit values. {{ ::circuitvaluespredreport.png?nolink |}} This matrix file indicates for each "effector circuit" the level of activation calculated using Hipathia method for each sample. ==== Model training ==== Here you can visualize the results from the prediction analysis. * **K-fold cross-validation**: The number of equal sized subsamples in which the original sample is randomly partitioned. {{ ::k-foldcrossvalidation.png?nolink |}} * **SVM-RBF hypermeter performance** {{ ::hyperparameterpredreport.png?nolink |}} * **Test model statistics**: {{ ::testmodelstatistics.png?nolink |}} * **Split Train pr**: {{ ::splittrainpr.png?nolink |}} * **Split Train roc**: {{ ::splittrainroc.png?nolink |}} * **Split Test pr**: {{ ::splittestpr.png?nolink |}} * **Split Test roc**: {{ ::splittestroc.png?nolink |}} ==== Prediction model ==== {{ ::predictionmodelreport.png?nolink |}} ==== Model statistics ==== You can download the model statistics. * **Selected features**: You can download the filtered paths that best differentiate your phenotype. This section is only available when selecting //filter paths// option.