iReport: a generalised Galaxy solution for integrated experimental reporting
© Hiltemann et al.; licensee BioMed Central Ltd. 2014
Received: 30 July 2014
Accepted: 29 September 2014
Published: 13 October 2014
Galaxy offers a number of visualisation options with components, such as Trackster, Circster and Galaxy Charts, but currently lacks the ability to easily combine outputs from different tools into a single view or report. A number of tools produce HTML reports as output in order to combine the various output files from a single tool; however, this requires programming and knowledge of HTML, and the reports must be custom-made for each new tool.
We have developed a generic and flexible reporting tool for Galaxy, iReport, that allows users to create interactive HTML reports directly from the Galaxy UI, with the ability to combine an arbitrary number of outputs from any number of different tools. Content can be organised into different tabs, and interactivity can be added to components. To demonstrate the capability of iReport we provide two publically available examples, the first is an iReport explaining about iReports, created for, and using content from the recent Galaxy Community Conference 2014. The second is a genetic report based on a trio analysis to determine candidate pathogenic variants which uses our previously developed Galaxy toolset for whole-genome NGS analysis, CGtag. These reports may be adapted for outputs from any sequencing platform and any results, such as omics data, non-high throughput results and clinical variables.
iReport provides a secure, collaborative, and flexible web-based reporting system that is compatible with Galaxy (and non-Galaxy) generated content. We demonstrate its value with a real-life example of reporting genetic trio-analysis.
KeywordsGalaxy Generic reporting application Next generation sequencing Genetic variation Pathogenic gene selection
Structured reporting and documentation of experimental outcome is required for the successful transfer of knowledge from the research scientist to their peers and to the broader academic community.
Galaxy is a platform that aims to provide complex bioinformatics services and tools in an easy-to-use web-based graphical user interface [1–3]. The output from these tools can be displayed using built-in Galaxy visualisation applications , via specialised visuals implemented as a component in the workflow deployed in Galaxy  or by downloading the results and visualising the output with applications external to Galaxy (e.g., Excel, TIBCO spotfire, R, spreadsheet programs, etc).
Galaxy has the capacity to track the provenance of the source data, the workflow, as well as the workflow components used to analyse the data. Currently users can share their workflow and results within Galaxy, but do not have access to a simple method to summarise results from multiple tools and/or workflows in an integrated report. To address this issue we have developed iReport, an integrated reporting application that provides users with a flexible means to produce dynamic HTML reports which can be shared with other Galaxy users or downloaded to disk.
We demonstrate iReport’s utility through an example where a genetic report is generated from outputs of an existing Galaxy next-generation sequencing (NGS) toolkit, CGtag . iReport can also be used as an electronic lab notebook by creating an iReport which links out to various other iReports containing different analysis reports from various samples. It can be also be coupled to output from other Galaxy instances, for example output generated by specialized Galaxy instances such as Confero , ORIONE , and Galaxy-P .
The generic reporting functionality and usage of iReport is outlined below using an example iReport created for the recent Galaxy Community Conference, which is also available for viewing online . It is followed by an example of a genetic report that can be used for trio analysis, which can easily be modified for any trio reporting or extended to quartets or larger families, also available from our demo galaxy .
- 1.A cover page
Title of the report
- 2.Main report page consisting of a set of tabs. Each tab consisting of one or more content items. Each content item can be one of the following types:
An iReport tutorial has been developed to demonstrate and explain the functionality of iReport, and is available as a shared history from the CTMM-TraIT public Galaxy instance . The following sections describe each of the components of iReport in more detail.
Main report page
Content item: text field
Text can be entered in a text field in the tool interface, for example to create an introduction paragraph and to give a description of the items on the page. Text is printed verbatim, although a small number of HTML tags are allowed in order to give the user some control over formatting (e.g., b,i,em, strong, h1-h6 tags). Text files can also be specified, and the contents of the file will be printed to the screen verbatim.
Content item: images
Content item: tables
Content item: PDF files
Content item: links
Genetic report for a trio of HapMap individuals
Accurate, reproducible and traceable reporting is an essentialrequirement to the evaluation of the genetic outcome from any assay , including those variations predicted from NGS analysis. Since iReport is capable of including many formats, we have used the outcome from a trio analysis generated from the Complete Genomics  NGS platform to demonstrate its utility in representing these data in a user-defined format, which contains the provenance of the underlying analysis. In this example we use a trio of individuals sequenced in the International HapMap Project [37, 38], to demonstrate how to select protein affecting candidate variants based on a recessive genetic model. All data in this example is freely available for download from the Complete Genomics website .
iReport is a easy-to-use, flexible tool for generating traceable, standardized reports which are easily shared between users within and across platforms. We have demonstrated that iReport is capable of creating a customised genetics report from results generated within Galaxy and may be shared with collaborators on the same platform, or with the public. Additionally, data or results generated externally can be uploaded into Galaxy and can also be used by iReport. These reports are generated as web pages and may be downloaded in their entirety to be easily shared across systems.
The genetics report presented here represents the bare minimal reporting that is required to summarise the output for a genetic variation analysis. Whilst we used a trio of individuals to demonstrate how to select protein-affecting candidate variants based on a recessive model, any number of model outcomes and other assay results may be included in an iReport.
We developed iReport to simplify reporting and sharing the output from omics and non-high throughput assays analysed both in and external to Galaxy. We have also utilised iReport for more complex analysis workflows, such as summarising translational research and diagnostic applications for cancer and immunological research and diagnostics.
Availability and requirements
Project name: iReport Project home page: https://github.com/shiltemann/iReport CTMM-TraIT public Galaxy instance: http://galaxy.ctmm-trait.nl iReport tool shed repository: https://toolshed.g2.bx.psu.edu/view/saskia-hiltemann/ireport Operating system(s): Unix-based Operating Systems Programming languages: Bash, Perl, Python Other Requirements: Galaxy License: GNU GPL Any restrictions to use by non-academics: none Examples: iReport about iReport published history: http://galaxy.ctmm-trait.nl/u/saskia-hiltemann/h/gcc2014-ireport-about-ireport,ortinyurl.com/llrzz9w Clinical Genetics iReport published history: http://galaxy.ctmm-trait.nl/u/andrew-stubbs/h/ireportgeneticreportchr21
Availability and supporting data
The iReport tool, user manual (published page), and example data and histories are available at the CTMM-TraIT Galaxy server .
Complete genomics toolkit and annotation in a cloud-based galaxy
Center for Translational Molecular Medicine - Translational IT
Next generation sequencing
Uniform resource locator.
This study was performed within the framework of the Center for Translational Molecular Medicine (CTMM). TraIT project (grant 05T-401).
This work was sponsored by the BiG Grid project for the use of the computing and storage facilities, with financial support from the Nederlandse Organisatie voor Wetenschappelijk Onderzoek (Netherlands Organisation for Scientific Research, NWO).
- Goecks J, Nekrutenko A, Taylor J, The Galaxy Team:Galaxy: a comprehensive approach for supporting accessible, reproducible, and transparent computational research in the life sciences. Genome Biol. 2010, 11 (8): R86-10.1186/gb-2010-11-8-r86.View ArticlePubMedPubMed CentralGoogle Scholar
- Blankenberg D, Von Kuster G, Coraor N, Ananda G, Lazarus R, Mangan M, Nekrutenko A, Taylor J:Galaxy: a web-based genome analysis tool for experimentalists. Curr Protoc in Mol Biol. 2010, Chap. 19.10.1–21. [https://wiki.galaxyproject.org/CitingGalaxy],Google Scholar
- Giardine B, Riemer C, Hardison RC, Burhans R, Elnitski L, Shah P, Zhang Y, Blankenberg D, Albert I, Taylor J, Miller W, Kent WJ, Nekrutenko A:Galaxy: a platform for interactive large-scale genome analysis. Genome Res. 2005, 15 (10): 1451-1455. 10.1101/gr.4086505.View ArticlePubMedPubMed CentralGoogle Scholar
- Goecks J, Eberhard C, Too T, Nekrutenko A, Taylor J, The Galaxy Team:Web-based visual analysis for high-throughput genomics. BMC Genomics. 2013, 14: 397-10.1186/1471-2164-14-397.View ArticlePubMedPubMed CentralGoogle Scholar
- Hiltemann S, Mei H, de Hollander M, Palli I, van der Spek P, Jenster G, Stubbs A:CGtag: Complete Genomics toolkit and annotation in a cloud-based Galaxy. GigaScience. 2014, 3 (1): 1-10.1186/2047-217X-3-1.View ArticlePubMedPubMed CentralGoogle Scholar
- Ad Hoc Reporting. [http://reporting.inetsoftware.de/public/remote/adhoc],
- Google Charts. [https://developers.google.com/chart/],
- Apache OpenOffice - The Free and Open Productivity Suite. [https://www.openoffice.org/],
- Bioconductor: Open Source Software for Bioinformatics. [http://www.bioconductor.org],
- Krzywinski M, Schein J, Birol I, Connors J, Gascoyne R, Horsman D, Jones SJ, Marra MA:Circos: an information aesthetic for comparative genomics. Genome Res. 2009, 19 (9): 1639-1645. 10.1101/gr.092759.109.View ArticlePubMedPubMed CentralGoogle Scholar
- Circos Circular Visualisation. [http://circos.ca],
- OmniViz. [http://www.instem.com/solutions/omniviz.html],
- Partek: NGS and Microarray Data Analysis Software. [http://www.partek.com],
- TIBCO Spotfire: Business Intelligence Analytics Software and Data Visualization. [spotfire.tibco.com],
- IDBS E-Workbook. [http://www.idbs.com/en/platform-products/e-workbook/inforsense-for-e-workbook/],
- GenSight: Enterprise Portfolio Management Solutions. [http://www.gensight.com],
- Cartagenia. Confidently Interpret, Report and Share Genomic Variants. [http://www.cartagenia.com],
- Sharma MK, Philips J, Agarwal S, Wiggins WS, Shrivastava S, Koul SB, Bhattacharjee M, Houchins CD, Kalakota RR, George B, Meyer RR, Spencer DH, Lockwood CM, Nguyen TT, Duncavage EJ, Al-Kateb H, Cottrell CE, Godala S, Lokineni R, Sawant SM, Chatti V, Surampudi S, Sunkishala RR, Darbha R, Macharla S, Milbrandt JD, Virgin HW, Mitra RD, Head RD, Kulkarni S:Clinical genomicist workstation. AMIA Jt Summits Transl Sci Proc. 2013, 19 (9): 156-157.Google Scholar
- KnitR: A General-purpose Package for Dynamic Report Generation in R. [http://cran.r-project.org/web/packages/knitr/],
- Leisch F:Sweave: Dynamic generation of statistical reports using literate data analysis. Proc Comp Stat. 2002, 575-580.Google Scholar
- R-Markdown. [http://shiny.rstudio.com/articles/rmarkdown.html],
- Tangle. [http://worrydream.com/Tangle/],
- Active Markdown. [http://activemarkdown.org/],
- IPython Notebooks. [http://ipython.org/notebook.html],
- Hermida L, Poussin C, Stadler MB, Gubian S, Sewer A, Gaidatzis D, Hotz H-R, Martin F, Belcastro V, Cano S, Peitsch MC, Hoeng J:Confero: an integrated contrast data and gene set platform for computational analysis and biological interpretation of omics data. BMC Genomics. 2013, 14: 514-10.1186/1471-2164-14-514.View ArticlePubMedPubMed CentralGoogle Scholar
- Cuccuru G, Orsini M, Pinna A, Sbardellati A, Soranzo N, Travaglione A, Uva P, Zanetti G, Fotia G:Orione, a web-based framework for NGS analysis in microbiology. Bioinformatics. 2014, 30 (10): 1928-1929.View ArticlePubMedPubMed CentralGoogle Scholar
- Galaxy-P. [https://usegalaxyp.org/],
- CGtag Pipeline with iReport as Final Step. [http://galaxy.ctmm-trait.nl/u/saskia-hiltemann/p/cgtag],
- iReport Example: Tutorial GCC2014. [http://galaxy.ctmm-trait.nl/u/saskia-hiltemann/h/gcc2014-ireport-about-ireport],
- iReport Example: Genetic Report. [http://galaxy-demo.trait-ctmm.cloudlet.sara.nl/u/andrew-stubbs/h/ireportgeneticreportchr21],
- jQuery Zoom Library. [http://www.jacklmoore.com/zoom/],
- DataTables | Table Plug-in for jQuery. [https://datatables.net],
- Rebhan M, Chalifa-Caspi V, Prilusky J, Lancet D:GeneCards: A novel functional genomics compendium with automated data mining and query reformulation support. Bioinformatics. 1998, 14 (8): 656-664. 10.1093/bioinformatics/14.8.656.View ArticlePubMedGoogle Scholar
- GeneCards - The Human Gene Compendium. [http://www.genecards.org],
- MacLean B, Tomazela DM, Shulman N, Chambers M, Finney GL, Frewen B, Kern R, Tabb DL, Liebler DC, MacCoss MJ:Skyline: an open source document editor for creating and analyzing targeted proteomics experiments. Bioinformatics. 2010, 26 (7): 966-968. 10.1093/bioinformatics/btq054.View ArticlePubMedPubMed CentralGoogle Scholar
- Drmanac R, Sparks A, Callow M, Halpern A, Burns N, Kermani B, Carnevali P, Nazarenko I, GB Nilsen G, Yeung G, Dahl F, Fernandez A, Staker B, Pant K, Baccash J, Borcherding A, Brownley A, Cedeno R, Chen L, Chernikoff D, Cheung A, Chirita R, Curson B, Ebert J, Hacker C, Hartlage R, Hauser B, Huang S, Jiang Y, Karpinchyk V:Human genome sequencing using unchained base reads on self-assembling dna nanoarrays. Science. 2010, 327 (5961): 78-81. 10.1126/science.1181498.View ArticlePubMedGoogle Scholar
- The International HapMap Consortium:The international hapmap consortium. the international hapmap project. Nature. 2003, 426: 789-796. 10.1038/nature02168.View ArticleGoogle Scholar
- The International HapMap Consortium:Integrating common and rare genetic variation in diverse human populations. Nature. 2010, 467: 52-58. 10.1038/nature09298.View ArticleGoogle Scholar
- Complete Genomics Public Datasets. [http://www.completegenomics.com/public-data/],
- CTMM-TraIT Public Galaxy Instance. [http://galaxy.ctmm-trait.nl],
This article is published under license to BioMed Central Ltd. This is an Open Access article distributed under the terms of the Creative Commons Attribution License (http://creativecommons.org/licenses/by/4.0), which permits unrestricted use, distribution, and reproduction in any medium, provided the original work is properly credited. The Creative Commons Public Domain Dedication waiver (http://creativecommons.org/publicdomain/zero/1.0/) applies to the data made available in this article, unless otherwise stated.