How to use the Recipe Resource and recipes

How to use the recipe homepage

The Recipe Resource is a repository for GenomeSpace recipes - short, standalone workflows for completing complex bioinformatic analyses. Recipes use GenomeSpace-enabled tools and data resources to demonstrate integrative analysis, walking users step-by-step through the process of obtaining and analyzing data. The Recipe Resource homepage functions as an access portal to recipes and recipe-related content, such as documentation for using and developing recipes.

The content of the Recipe Resource homepage is organized into the following categories:

Recipe Resource Guide
The guide links to other useful recipe-related documentation, e.g. how to use the recipe resource (this page), how to create your own recipes, and how to participate in the GenomeSpace community.
Browse Recipes
Access the current list of published recipes using the search box with a search term (e.g. a tag or other word of interest), or by clicking on the List All Recipes button to jump straight to the recipe list.
Featured Recipes
Featured recipes are chosen by the GenomeSpace team based on the quality, utility and popularity of the recipe. The featured recipe rotates frequently, so check back often to see our latest pick!
Contribute Recipes
To post a recipe to the Recipe Resource, please read the Best Practices guideline for recipe development first. User-contributed recipes will first be reviewed by the GenomeSpace team to prevent misuse, and once approved will be made available to for public use. We make use of Faculty of 1000 (F1000) Research to publish open access and peer-reviewed recipes from the Recipe Resource. Once your recipe has been added to the Recipe Resource, you are invited to publish the recipe in the GenomeSpace F1000Research channel. Please make sure to only publish F1000 papers on recipes that have been contributed to the Recipe Resource, and which have been reviewed by the GenomeSpace team.  To submit to the F1000 channel, please email the GenomeSpace team to coordinate the submission. Once the publication is submitted to F1000, it will undergo peer review according to the F1000 publication guidelines.
Community
To contribute to community discussions, join the GenomeSpace community forum! You can also email us with questions or comments. If you have questions or suggestions about a particular recipe, please use the comment area at the bottom of each recipe page, which allows logged-in GenomeSpace members to give us feedback on recipes.

 

How to use the recipe list

The Recipe Resource list is the list of all currently published recipes. This is the portal to reading, browsing, searching, and filtering all published recipes. The following explains how to navigate the recipe list, in order to find the recipe that best suits your interests and analysis needs.

Login navigation

When logged in, a GenomeSpace user will see a login navigation menu allowing access to features of the Recipe Resource. The house icon will return the user to the recipe homepage. The My Recipes icon allows users to access the recipes they have created. Here, users can add, edit, or delete recipes, or re-order the steps in the recipes.

Users can also search through the published list of recipes by using the search bar. If users have searched for a specific term, limiting the number of recipes displayed, they can re-set the list to show all recipes by clicking the List All button.

Recipe descriptions and links

Each recipe listing has a descriptive title of the analysis, e.g. "Build and visualize a module network using putative aberrant regions and expression data". Each title is accompanied by a graphic depicting the tools used in the recipe (e.g. Galaxy and GenePattern). Each recipe has a short description of the basic input and analysis of the recipe, which can be accessed by clicking on the recipe title box to expand or collapse the short description. Clicking on the recipe title will re-direct the page to the recipe itself. To see all the recipe descriptions, click the Expand all recipe descriptions link. Once expanded, the link can be used to collapse all recipe descriptions, as well.

Filtering recipes

Recipes are tagged with certain information to make searching and filtering recipes easier. Recipes can be filtered by tags, which are categorized into several types:

  • Tool type: Identifies which GenomeSpace-enabled tool is used in a recipe. More than one tool can be used in a recipe.
  • Data type: Identifies the input data type being used in a recipe, e.g. whether the input data is DNA or RNA, array data or sequencing data, etc.
  • Analysis type: Identifies the analysis completed in the recipe, e.g. building a network, identifying differentially expressed genes, etc. The analysis type is related to data type in some ways, but many different data types can be associated with an analysis.

To filter the list of recipes by tags of interest, select the tag that you are interested in filtering by. For example, if you want to find all recipes utilizing GenePattern, click on the GenePattern tag under the Filter by tool category. The list of recipes is automatically updated based on the user selection of tags. More than one tag can be selected both within and between categories.

Within a category, multiple tags can be selected by either clicking and dragging, or by using ctrl+click to select tags. Selecting more than one tag within a category will filter the list of recipes as an inclusive or query, e.g. selecting both the GenePattern and Cytoscape tags will reduce the list to recipe utilizing GenePattern OR Cytoscape. If a recipe uses both tools, that recipe will be included.

Between categories, if multiple tags are selected the list of recipes will be filtered as an and query. For example, selecting GenePattern from the list of tool tags and RNA-Seq from the list of data tags, will filter the recipes to include only recipes that utilize GenePattern AND feature RNA-Seq datasets.

Filters can be combined across datasets in a similar way. Selecting the GenePattern, Cytoscape, and RNA-Seq tags results in a list of recipes that utilize (GenePattern OR Cytoscape) AND feature RNA-Seq data.

To clear the filters, click the clear button.

 

How to use recipes

Recipes are short, standalone workflows describing the steps necessary to complete a common bioinformatic analysis, such as quality-checking RNA-Seq data, building a network from a list of genes, or identifying differentially regulated genes. Recipes usually feature two-three GenomeSpace-enabled tools or data sources. They can be used sequentially to create a longer or more complex analysis.

Recipes can be navigated to using the recipe list, or by using the search box on the Recipe Resource home page. There are several features on recipe pages to help users understand and utilize the recipe content.

Metadata

Each recipe features a header, which lists metadata about that recipe. For example, an image accompanies the title, illustrating the tools used in the recipe. The date and author of the recipe is listed. A GenomeSpace cloud icon ( ) indicates 'official' recipes that have been created by the GenomeSpace team. Underneath this, tags for data type and analysis type are listed for each recipe. Finally, each recipe features a rating system where users can either upvote () or downvote () the recipes to give feedback on recipes. Ideally, users will also comment on the recipe to leave questions, or feedback about the recipe quality or utility. However, looking at the upvotes and downvote on a recipe allows a user to quickly judge if that recipe is considered useful by the GenomeSpace user community. Only logged-in users can upvote or downvote recipes.

Sidebar navigation menu

Recipes have a dynamically-generated navigation menu. Users can click on individual items of the navigation bar, to automatically jump to that part of the recipe page. The navigation menu will scroll with the user. The navigation menu will display the top-level links for each section of a recipe. In the case of recipe sections that have sub-headings (e.g. the Steps section of a recipe) the navigation menu will expand to list the sub-steps once the user has reached that section of the recipe. Upon moving to a different section, this will collapse to hide the extra sub-headings. The Back to the Top link allows the user to jump to the top of the recipe page at any time.

Summary
Recipes contain a section for the summary of the recipe. This typically contains an overview cartoon, which is a visually appealing flowchart of the recipe, listing the input data, analysis, and output data which are used in a recipe. The summary section describes the biological premise for doing a bioinformatic analysis as described in the recipe. If the recipe is recapitulating published data, it will feature a brief description of the published research and its conclusions, as well as links to the articles in PubMed.
Inputs
This section describes the input data necessary to complete the recipe. Users can either use the example data featured in the recipe, or they can provide their own data. If users choose to use example data, links to the data are provided, and directions for importing or obtaining the data are described.
Outputs
This section briefly describes the output that a user can expect, if following the recipe steps using the recipe example input data.
Recipe steps
The overview of recipe steps lists, briefly, the basic instructions for each step of the recipe, grouped by the tool being used. If a user is moderately familiar with bioinformatic analyses, or is interested in using some of their own methods for analysis, this overview section provides the basic information necessary to complete the recipe, which the user can alter to suit their own needs.
Recipe steps
Recipe steps are the individual steps for completing the analysis, e.g. "loading data files". Recipe steps usually feature three ways to describe the step: (1) a brief description; (2) a detailed step-by-step description, including instructions on which parameters to use, or buttons to click; and, (3) a video which completes the step-by-step instructions. A user may want to utilize some or all of these descriptions, depending on their level of familiarity with the analysis.

The brief description of a recipe step is always displayed to the user. However, due to the amount of content, the step-by-step instructions and the videos are contained in collapsible/expandable boxes, for ease of use. To expand or collapse a step, a user should click on the step box to toggle it. To expand or collapse all the steps, the user can click on the Expand All Steps or Collapse All Steps buttons.

Example of a recipe step, in its collapsed configuration. The text visible is a brief description of the recipe step. When the recipe step is clicked, it expands to reveal the step-by-step instructions, screenshots, and videos.

 

Step-by-step instructions for recipes will feature screenshots. These screenshots usually depict the interface of the tool being used, and contain highlights or other indicators to help users understand the parameters being changed in the interface. In addition, the detailed step-by-step instructions accompany the screenshots. For steps with videos, the video is embedded into the webpage. For individual steps, the videos are short for ease of viewing. If a user is interested in viewing all of the videos in a recipe, there is a video playlist featured at the top of each recipe. This is a YouTube compilation of the individual videos, which can also be watched on the GenomeSpace YouTube channel.

Results Interpretation
Recipes feature a results interpretation section to help users understand the biological meaning of the recipe output. If the user follows along with the recipe and uses the recipe example input data, the results interpretation section should accurately represent the results the user obtains. However, they are by no means a comprehensive description of the results, and are only meant to act as an example interpretation of the data. The results interpretation section also typically features screenshots of the results.
Comments

GenomeSpace users are encouraged to comment on recipes and leave feedback about the recipe content. If logged in, users can type a comment into the Content box, and click the Submit Your Comment button to submit the comment. The comment will be logged with the date, time, and author's GenomeSpace username. Users are invited to ask questions about recipes, suggest alternative parameters or analyses, suggest improvements to recipes, and leave other feedback for the GenomeSpace team.