User Tools

Site Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
wiki:guides:authors:parametric_studies [2016/03/14 07:31]
Brian Collins [Full Results Pages]
wiki:guides:authors:parametric_studies [2016/03/14 08:10] (current)
Brian Collins
Line 7: Line 7:
 Allowing an EASAP to be submitted as a parametric study is optional, and as an author, you have complete control over when and how the parametric study capability is activated within an EASAP. ​ Allowing an EASAP to be submitted as a parametric study is optional, and as an author, you have complete control over when and how the parametric study capability is activated within an EASAP. ​
  
-In order to enable parametric study input for an EASAP, you must first define your **[[wiki:​guides:​authors:​objects:​inputbox|Input Box]]** as a number type input by choosing any of the following options for the parameter **Input Type:**+In order to enable parametric study input for an EASAP, you must first set **Input Type:** to a number for an **[[wiki:​guides:​authors:​objects:​inputbox]]** ​(choose from below):
  
   * Number   * Number
Line 14: Line 14:
  
 ----- -----
-**Note: ​You may enter data according to the selected input type. For example, ​if you wish to enter the value 10%” and Input Type is set to Numericyou should ​enter ”0.1However, ​if Input Type is Percentage, the same value should be entered as 10.**+**Note:** Data entries are interpreted ​according to the **Input Type:**. For example, to enter the value '10%' ​and **Input Type:** is set to '​Number'​the entry should ​be '0.1'Similarly ​if **Input Type:** is 'Percentage', the same value should be entered as '10'.
 ----- -----
  
-Once you have chosen a compatible input type, you can enable parametric range functionality by adding ​the [[wiki:​guides:​authors:​objects:​parametric_range]] ​child object to the Input BoxThe Parametric Range object ​is a parameterless object which enables **List Range** input functionality.+Once you have chosen a compatible input type, you can enable parametric range functionality by adding ​a **Child** ​[[wiki:​guides:​authors:​objects:​parametric_range]] ​under the **INPUT BOX****PARAMETRIC RANGE** ​is a parameterless object which enables **List Range** input functionality.
  
-When Parametric Ranges have been enabled for an Input Box, the Specify Range button ({{:​wiki:​icons:​selectrange.png?​nolink|}}) will appear on the user interface to the right of the box. Users click on this button to modify the Parametric Range settings for the data entry box.+When Parametric Ranges have been enabled for an **INPUTBOX**, the 'Specify Range' ​button ({{:​wiki:​icons:​selectrange.png?​nolink|}}) will appear on the user interface to the right of the box. Users click on this button to modify the Parametric Range settings for the **INPUTBOX**.
  
 ==== Parametric Settings Form ==== ==== Parametric Settings Form ====
Line 27: Line 27:
 {{ :​wiki:​guides:​authors:​parametric_settings_form3.png?​nolink |}} {{ :​wiki:​guides:​authors:​parametric_settings_form3.png?​nolink |}}
  
-In order to enable an Input Box for parametric submissions,​ users must first click the ‘Enable’ radio button at the top-right of the Parametric Settings form. When enabled, the Input Box will allow for **List Range** parametric submissions in the form of a comma-seperated ​list of values entered into the text area of the **Values** tab+In order to enable an **INPUTBOX** ​for parametric submissions,​ users must first click the ‘Enable’ radio button at the top-right of the Parametric Settings form. When enabled, the **INPUTBOX** ​will allow for **List Range** parametric submissions in the form of a comma-separated ​list of values entered into the text area of the **Values** tab
  
 ==== Multiple Input Values ==== ==== Multiple Input Values ====
  
-Another feature of the Parametric Settings form is the ability to view information about **List Range** values from many parametric input objects in a single table. The **All Values** tab provides a convenient overview of the runs to be submitted and respective ​Input Box values for each. An example of the All Values tab is shown below.+Another feature of the Parametric Settings form is the ability to view information about **List Range** values from many parametric input objects in a single table. The **All Values** tab provides a convenient overview of the runs to be submitted and respective ​**INPUTBOX** ​values for each. An example of the 'All Values' ​tab is shown below.
  
 {{ :​wiki:​guides:​authors:​parametric_form_all_values2.png?​nolink |}} {{ :​wiki:​guides:​authors:​parametric_form_all_values2.png?​nolink |}}
  
 ----- -----
-**Note: ​Successful use of multiple parametric ​Input Box objects depends on all List Ranges ​being equal in length.**+**Note:** For multiple parametric ​**INPUTBOX**'​s ​ 'List Ranges' must be equal in length.
 ----- -----
  
 ===== Creating Parametric Study Output ===== ===== Creating Parametric Study Output =====
  
-A powerful feature of EASAPs is the ability to allow parametric studies to be set up and submitted quickly using Parametric Range settings in User Interface ​objects, like the [[wiki:​guides:​authors:​objects:​realbox]]. To compliment this capability, a special report, the [[wiki:​guides:​authors:​objects:​parametric_report]] ​object, ​is available on the **Output** branch for producing output that allows users to compare results from every run submitted as part of a parametric study. The **Parametric Report** object has two children ​objects, the [[wiki:​guides:​authors:​objects:​parametric_table]] and [[wiki:​guides:​authors:​objects:​parametric_graph]] ​objects.+A powerful feature of EASAPs is the ability to allow parametric studies to be set up and submitted quickly using Parametric Range settings in **USER INTERFACE** ​objects, like the [[wiki:​guides:​authors:​objects:​realbox]]. To compliment this capability, a special report [[wiki:​guides:​authors:​objects:​parametric_report]] is available on the **OUTPUT** branch for producing output that allows users to compare results from every run submitted as part of a parametric study. The **Parametric Report** object has two **Child** ​objects[[wiki:​guides:​authors:​objects:​parametric_table]] and [[wiki:​guides:​authors:​objects:​parametric_graph]].
  
 ===== Viewing Parametric Study Results ===== ===== Viewing Parametric Study Results =====
  
-When a user makes a multiple-run parametric study submission, the way in which the generated results are structured and presented to them changes from what is done for a single run submission. The first difference is that the button displayed in the **Results** column of the results table under the **My Results** or **All Results** menus will change from {{:​wiki:​icons:​results.png?​nolink|}} to a different button. The button shown depends on the type of multiple run submission that was made. A list of the different buttons is given below:+When a user makes a multiple-run parametric study submission, the way in which the generated results are structured and presented to them changes from what is done for a single run submission. The first difference is that the button displayed in the **Results** column of the results table under **EASA->​User->​Results->​My Results** menus will change from {{:​wiki:​icons:​results.png?​nolink|}} to a different button. The button shown depends on the type of multiple run submission that was made. A list of the different buttons is given below:
  
-  * **Parametric** ({{:​wiki:​icons:​range.gif?​nolink|}}) - Displays the Multiple Runs or Full Results page of a Linear Range type submission.+  * **Parametric** ({{:​wiki:​icons:​range.gif?​nolink|}}) - Displays the 'Multiple Runs' ​or 'Full Results' ​page of a 'Linear Range' ​type submission.
  
-  * **List** ({{:​wiki:​icons:​list.gif?​nolink|}}) - Displays the Multiple Runs or Full Results page of a List Range type submission.+  * **List** ({{:​wiki:​icons:​list.gif?​nolink|}}) - Displays the 'Multiple Runs' ​or 'Full Results' ​page of a 'List Range' ​type submission.
  
   * **Parametric Plus** ({{:​wiki:​icons:​parametric_plus.gif?​nolink|}}) - Same as Parametric except with a List Range submitted in addition.   * **Parametric Plus** ({{:​wiki:​icons:​parametric_plus.gif?​nolink|}}) - Same as Parametric except with a List Range submitted in addition.
Line 59: Line 59:
 A Multiple Runs page is characterized by tables or graphs that display key pieces of information or data from all runs as defined by the author in the **Parametric Report** and its children objects. These pages allow users to compare several runs from a parametric study all in one location. A Multiple Runs page is characterized by tables or graphs that display key pieces of information or data from all runs as defined by the author in the **Parametric Report** and its children objects. These pages allow users to compare several runs from a parametric study all in one location.
  
-On all **Multiple Runs** pages, there will be a link, results, that will take the user to the corresponding [[wiki:​guides:​authors:​parametric_studies#​Full Results Pages|Full Results Page]]).+On all **Multiple Runs** pages, there will be a link, results, that will take the user to the corresponding [[wiki:​guides:​authors:​parametric_studies#​Full Results Pages|Full Results Page]].
  
 ----- -----
-**Note: Depending on the number of parametric runs, it may take several seconds for the complete Multiple Runs page to appear.**+**Note:** Depending on the number of parametric runs, it may take several seconds for the complete Multiple Runs page to appear.
 ----- -----
  
-When users view a Parametric ​Multiple Runs page generated using Linear Ranges, they may see a table that is used to control the display of any and all parametric results tables and graphs on the page. This table is only displayed if they have set two or more linear ranges. The first column of this table shows all parameters for which the user created a linear range. In the second column, users can choose one parameter’s values to populate the rows of the subsequent parametric results tables and graphs. In the third column, users choose another parameter’s values to populate the columns, and in the fourth column, users specify the values for the remaining parameters.+When users view a 'Multiple Runs' ​page generated using 'Linear Ranges', they may see a table that is used to control the display of any and all parametric results tables and graphs on the page. This table is only displayed if they have set two or more linear ranges. The first column of this table shows all parameters for which the user created a linear range. In the second column, users can choose one parameter’s values to populate the rows of the subsequent parametric results tables and graphs. In the third column, users choose another parameter’s values to populate the columns, and in the fourth column, users specify the values for the remaining parameters.
  
 {{ :​wiki:​guides:​authors:​parametric_multiple_runs.jpg?​nolink |}} {{ :​wiki:​guides:​authors:​parametric_multiple_runs.jpg?​nolink |}}
  
 ----- -----
-**Note: Changes made in the Parameter Selection table are immediately invoked in the parametric tables and graphs found on the Multiple Runs page.**+**Note:** Changes made in the Parameter Selection table are immediately invoked in the parametric tables and graphs found on the Multiple Runs page.
 ----- -----
  
 ==== Full Results Pages ==== ==== Full Results Pages ====
  
-A Full Results page contains a table that will allow users to view the detailed results for the individual runs of the particular type of multiple run submission. The first column of the table on a Full Results page indicates the status of each run similar to that shown in the table of submitted runs in [[wiki:​guides:​users:​resultsmenu#​My Results|My Results]]. Users may be able to view a report for a single run by clicking on its **View Results** button ({{:​wiki:​icons:​results.png?​nolink|}}) in the **Results** column, or they may see another of the **View Results** buttons ({{:​wiki:​icons:​range.gif?​nolink|}},​ {{:​wiki:​icons:​list.gif?​nolink|}},​ {{:​wiki:​icons:​parametric_plus.gif?​nolink|}}) indicating that more than one multiple run method was used. The individual runs can be identified by the parameter values shown in the third column and onwards to the right in the table.+'Full Results' ​page contains a table that will allow users to view the detailed results for the individual runs of the particular type of multiple run submission. The first column of the table on a Full Results page indicates the status of each run similar to that shown in the table of submitted runs in EASA->​User->​Results->​[[wiki:​guides:​users:​resultsmenu#​My Results|My Results]]. Users may be able to view a report for a single run by clicking on its **View Results** button ({{:​wiki:​icons:​results.png?​nolink|}}) in the **Results** column, or they may see another of the **View Results** buttons ({{:​wiki:​icons:​range.gif?​nolink|}},​ {{:​wiki:​icons:​list.gif?​nolink|}},​ {{:​wiki:​icons:​parametric_plus.gif?​nolink|}}) indicating that more than one multiple run method was used. The individual runs can be identified by the parameter values shown in the third column and onwards to the right in the table.
  
-The multiple runs link will take users to the corresponding Multiple Runs page. An example of a Full Results page for a Linear Range run is shown below.+The multiple runs link will take users to the corresponding ​'Multiple Runs' ​page. An example of a 'Full Results' ​page for a 'Linear Range' ​run is shown below.
  
 {{ :​wiki:​guides:​authors:​full_results_page2c.png?​nolink |}} {{ :​wiki:​guides:​authors:​full_results_page2c.png?​nolink |}}

Page Tools