Abstract
Objective
Sierra Platinum is a fast and robust peak-caller for replicated ChIP-seq experiments with visual quality-control and -steering. The required computing resources are optimized but still may exceed the resources available to researchers at biological research institutes.
Results
Sierra Platinum Service provides the full functionality of Sierra Platinum: using a web interface, a new instance of the service can be generated. Then experimental data is uploaded and the computation of the peaks is started. Upon completion, the results can be inspected interactively and then downloaded for further analysis, at which point the service terminates.
Introduction
ChIP-seq has become an important high throughput technique for analyzing protein–DNA interaction. It is routinely employed for identifying transcription factor binding sites and for determining chromatin states by virtue of immunoprecipitation of nucleosomes that exhibit histones with specific chemical modifications. The basic principle of ChIP-seq is the specific enrichment of immunoprecipitated DNA-protein aggregates, from which—after sequencing the DNA component—the genomic location of the DNA–protein interactions of interest are inferred. The key step in the analysis of ChIP-seq data is peak-calling, that is, the determination of those genomic regions in which immunoprecipitated DNA is significantly enriched relative to “empty” control samples [1].
Since the introduction of ChIP-seq, several peak callers were published, e.g., MACS [2], PeakSeq [3], and csaw [4]. However, most of them handle only one pair of experiment and control or perform a differential peak-calling between two experiments. Their performances were reviewed by Wilbanks and Facciotti [5] and by Koohy et al. [6]. Tools for multi-replicate peak-calling were developed only recently. Among them, Sierra Platinum [7] combines multiple ChIP-seq experiments in a single peak calling process and thus makes full use of the information supplied by replicates. It provides extensive visualization options to guide the user through the evaluation of the experiments. This enables the user to inspect the replicate’s quality in various ways, and to enhance the peak-calling quality by weighting or excluding individual samples. The GUI of Sierra Platinum further facilitates immediately comparing the impact of different parameter settings. Compared to other currently available peak-calling tools, Sierra Platinum performs best with respect to recall and false discovery rate regardless of the data quality [7].
The computational efforts for ChIP-seq analysis require hardware that may not be available in labs without dedicated bioinformatics infrastructure due to the size of the input files and the complexity of the algorithms that combine multiple samples. To overcome this limitation, Sierra Platinum Service provides access to the full functionality of Sierra Platinum by providing a web-based service hosted at sierra.sca-ds.de. In addition, we provide a convenient docker image for easy deployment of private instances of the service, e.g., for institution-wide use.
Main text
Methods
The Sierra Platinum Service is a publicly available web service that combines user management, job control, and a queuing system as well as mechanisms for uploading the input data and for downloading all results. It creates a dedicated Sierra Platinum Server that allows the user to upload, analyze, inspect, and manipulate his ChIP-seq data using the Sierra Platinum Client with very little local resource consumption. Finally, the user can download all results—analysis results as well as the final peaks.
Usage and interaction
The service requires registration with a valid email address and allows the user to start a dedicated Sierra Platinum Server (SPS) for which he received the necessary credentials by email. A SPS runs for 72 h or until termination by the user. During this time, the user may disconnect from and reconnect to the server at any time. At the end of the SPS’s life time, all data is deleted from the server hardware. To use the SPS, the user connects with his credentials through the Sierra Platinum Client and first uploads his data as bam files using the integrated FTPS client. Then, the peak calling can be started. Afterwards, quality control information can be visually inspected (see Fig. 1) and parameters may be adjusted as for any local installation of Sierra Platinum (see Müller et al. [7] for details). At any time, the results file can be downloaded for further, local analysis.
Upper part: A replicate tab in the GUI of SPS. It shows the calculated properties of a replicate and enables the user to assess the quality and validity of the replicate. Lower part: The summary tab in the GUI of SPS. On the left hand side the correlations between the replicates used are displayed. On the right hand side the weighting mechanism controlling the influence the effect of single replicates on the final peak calling result is shown
Overview of the Sierra Platinum Service Docker container. The web server handles the user registrations and starts the Sierra Platinum Server after a valid activation. All necessary user information are stored in an SQLite database. After a successful registration the user can upload his data with the Sierra Platinum Client and start the computation. Afterwards, it is possible to export all results and visualizations within the client. The logos of NGINX, SQLite, and Docker were taken from Wikimedia Commons. The Docker and Sierra Platinum logo are licensed under Apache License 2.0
Technical realization
The server is hosted within a docker container (see Fig. 2), which provides a Java SDK for the SPS, a fully configured nginx web server with php5 support, and an SQLite database that stores the user management of the service. The mail transmission is implemented by using sSMTP that allows using an existing mail address without the need to setup an email server within the service.
Since the Sierra Platinum Service is embedded in a docker container, it can easily be deployed by pulling the Git repository https://github.com/sierraplatinum/sierra-service and running the scripts build.sh for building the container and run.sh for starting it. At this stage, the service can be configured by specifying TCP ports, the email address, and resource limitations such as the number of concurrent SPS instances or threads. To handle the limited number of SPS instances, a queuing system was implemented to handle all user requests. Within the docker container all services start automatically. The upload mechanism was implemented in the client/server core. To address security concerns, every user of the service is assigned his own FTPS directory and is jailed to it.
The client checks the validity of the uploaded files and the server can compute missing .bam indices. Interrupted uploads can be continued on the fly to accommodate for the large size of the input files.
Conclusion
Sierra Platinum Service provides full access to a state of the art ChIP-seq peak caller that can handle multiple replicates and that features extensive interactive quality control monitoring. Conceived as a server–client structure, it overcomes the need of extensive local computational resources and provides the user with simple client-based access. It is available as a docker container and thus can be deployed easily with little need for configuration, since docker is available for all common operating systems and the configuration of the docker container does not rely on the host system. This facilitates providing dedicated instances at the institutional level. Furthermore, the docker architecture is easily maintainable, since all updates can be pulled from the docker repository. Additionally, the implemented queuing system enables providing a Sierra Platinum Service for a larger group of users.
Limitations
The SPS architecture is currently designed as a split infrastructure. The registration and validation of a new user is handled by a web interface whereas the data upload, data processing, and data presentation is implemented within a Java GUI application. Therefore, the user needs an up-to-date Java installation on his client. Moreover, the data upload of the input files can take a long time depending on the user’s internet connection and the input size. If the user has a very slow upload rate, the maximal runtime of the service may exceed before finishing the upload. Further, the user needs a valid email address for the registration process.
Currently, the SPS instance at sierra.sca-ds.de is able to compute five jobs simultaneously. If necessary, the service can be extended easily with more slots since it is running on cluster system.
Abbreviations
- SPS:
-
Sierra Platinum Service
- ChIP-seq:
-
chromatin immunoprecipitation sequencing
- DNA:
-
deoxyribonucleic acid
- TCP:
-
Transmission Control Protocol
- FTPS:
-
FTP over SSL
References
Valouev A, Johnson DS, Sundquist A, Medina C, Anton E, Batzoglou S, Myers RM, Sidow A. Genome-wide analysis of transcription factor binding sites based on ChIP-seq data. Nat Methods. 2008;5:829–34.
Zhang Y, Liu T, Meyer CA, Eeckhoute J, Johnson DS, Bernstein BE, Nusbaum C, Myers RM, Brown M, Li W. Model-based analysis of ChIP-seq (MACS). Genome Biol. 2008;9(9):137.
Rozowsky J, Euskirchen G, Auerbach RK, Zhang ZD, Gibson T, Bjornson R, Carriero N, Snyder M, Gerstein MB. PeakSeq enables systematic scoring of ChIP-seq experiments relative to controls. Nat Biotechnol. 2009;27(1):66–75. https://doi.org/10.1038/nbt.1518.
Lun ATL, Smyth G. csaw: a Bioconductor package for differential binding analysis of ChIP-seq data using sliding windows. Nucleic Acids Res. 2015. https://doi.org/10.1093/nar/gkv1191. http://nar.oxfordjournals.org/content/early/2015/11/16/nar.gkv1191.full.pdf+html.
Wilbanks EG, Facciotti MT. Evaluation of algorithm performance in ChIP-seq peak detection. PLoS ONE. 2010;5(7):11471. https://doi.org/10.1371/journal.pone.0011471.
Koohy H, Down TA, Spivakov M, Hubbard T. A comparison of peak callers used for DNase-seq data. PLoS ONE. 2014;9(5):96303. https://doi.org/10.1371/journal.pone.0096303.
Müller L, Gerighausen D, Farman M, Zeckzer D. Sierra Platinum: a fast and robust multiple-replicate peak caller with visual quality-control and -steering. BMC Bioinform. 2016;17(1):1–13. https://doi.org/10.1186/s12859-016-1248-6.
Authors' contributions
DW implemented the Docker container. DW implemented the service modifications for Sierra Platinum. LM designed and implemented the website. JS deployed the service. DZ debugged and optimized the service. DW, LM, DZ, PS jointly designed the service architecture. DW, LM, JS, DZ, PS contributed to the manuscript writing. DW produced the figures. All authors read and approved the final manuscript.
Acknowledgements
We thank all our colleagues for fruitful discussions and Simon Andrews for his constructive comments.
Competing interests
The authors declare that they have no competing interests.
Availability of data and materials
The service is accessible at sierra.sca-ds.de. We made Sierra Platinum Service accessible as open source software at https://github.com/sierraplatinum/sierra-service.
Consent for publication
Not applicable.
Ethics approval and consent to participate
Not applicable.
Funding
This work has partially been funded by the Competence Center for Scalable Data Services and Solutions (ScaDS) Dresden/Leipzig (BMBF Grant 01IS14014B).
Publisher's Note
Springer Nature remains neutral with regard to jurisdictional claims in published maps and institutional affiliations.
Author information
Authors and Affiliations
Corresponding author
Rights and permissions
Open Access This article is distributed under the terms of the Creative Commons Attribution 4.0 International License (http://creativecommons.org/licenses/by/4.0/), which permits unrestricted use, distribution, and reproduction in any medium, provided you give appropriate credit to the original author(s) and the source, provide a link to the Creative Commons license, and indicate if changes were made. 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.
About this article
Cite this article
Wiegreffe, D., Müller, L., Steuck, J. et al. The Sierra Platinum Service for generating peak-calls for replicated ChIP-seq experiments. BMC Res Notes 11, 512 (2018). https://doi.org/10.1186/s13104-018-3633-x
Received:
Accepted:
Published:
DOI: https://doi.org/10.1186/s13104-018-3633-x