Web site data and documentation

Web portal displays all integrated tools following some standards to homogenize the data. Hence, there are a list of items required for tools developers to supply together with the tool itself in order to improve end user experience with the new application.

  1. Logo
    Format: PNG. Minimum size: 600x600px. It will be displayed in the homepage of the MuGVRE web portal

  2. Short description
    Short text presenting what the tool does (around 100-150 words). It will be displayed in the homepage of the MuGVRE web portal

  3. Tool web form
    The tool web form is filled in by the end user when defining the arguments of the tool, before clicking the “Compute” button. Input files and arguments are defined in the tool specification file. Yet, it needs to be manually specified if there are dependencies among parameters, or you want to group a certain number of arguments, or you have implemented a workflow with steps willing to be dynamically enabled, etc.

  4. Custom results viewer
    For those cases that generic visualizers are not of use, or require a place for showing their statistics, summaries, or results in a more specific way, we can create a custom HTML page. It can be found at the user workspace, next to the results of the tool finished project.

    If the data to be shown in this customized page is not contained in any of the tool output files that the end user will have listed in its workspace, you can create a hidden output file. This extra output file can contain the information willing to be displayed, can can easily be a TAR file including the graphs, lists and so on that you want to represent in this custom viewer page.

  5. Tool documentation
    Each tools integrated in the MuGVRE have a Help section in which tool developers add a description of their method, explains the output files they generate, add tips for the end user, etc. Consult current tool’s help for having an idea of the final result.

  6. Sample data
    Providing a golden dataset for the new tool is also required, as it ease the testing procedures, but it can also be uploaded at the MuGVRE portal as sample data (MuGVRE : Get data → Sample data) for your tool. In this way, new users are guided in what your tool can offer.