Commit a868004e authored by rhpvorderman's avatar rhpvorderman

Added some scaladocs strings

parent 09ea599c
...@@ -243,7 +243,7 @@ object BammetricsReport extends ReportBuilder { ...@@ -243,7 +243,7 @@ object BammetricsReport extends ReportBuilder {
} }
/** /**
* This is a generic method to create plots * This is a generic method to create a Map that can be turned into a plot
* @param libraryLevel If enabled the plots will show data per library * @param libraryLevel If enabled the plots will show data per library
* @param sampleId If set only this sample is shown * @param sampleId If set only this sample is shown
* @param libraryId If set onlt this library is shown * @param libraryId If set onlt this library is shown
...@@ -357,7 +357,7 @@ object BammetricsReport extends ReportBuilder { ...@@ -357,7 +357,7 @@ object BammetricsReport extends ReportBuilder {
* *
* @param outputDir OutputDir for the tsv and png file * @param outputDir OutputDir for the tsv and png file
* @param prefix Prefix of the tsv and png file * @param prefix Prefix of the tsv and png file
* @param insertSizePlotTables * @param insertSizePlotTables Plot map generated by insertSizePlotTables function.
*/ */
def insertSizePlot(outputDir: File, def insertSizePlot(outputDir: File,
prefix: String, prefix: String,
...@@ -461,9 +461,7 @@ object BammetricsReport extends ReportBuilder { ...@@ -461,9 +461,7 @@ object BammetricsReport extends ReportBuilder {
* *
* @param outputDir OutputDir for the tsv and png file * @param outputDir OutputDir for the tsv and png file
* @param prefix Prefix of the tsv and png file * @param prefix Prefix of the tsv and png file
* @param summary Summary class * @param wgsHistogramPlotTables Plot map generated by wgsHistogramPlotTables function.
* @param libraryLevel Default false, when set true plot will be based on library stats instead of sample stats
* @param sampleId Default it selects all sampples, when sample is giving it limits to selected sample
*/ */
def wgsHistogramPlot(outputDir: File, def wgsHistogramPlot(outputDir: File,
prefix: String, prefix: String,
...@@ -495,10 +493,8 @@ object BammetricsReport extends ReportBuilder { ...@@ -495,10 +493,8 @@ object BammetricsReport extends ReportBuilder {
* *
* @param outputDir OutputDir for the tsv and png file * @param outputDir OutputDir for the tsv and png file
* @param prefix Prefix of the tsv and png file * @param prefix Prefix of the tsv and png file
* @param summary Summary class * @param rnaHistogramPlotTables Plot map generated by rnaHistogramPlotTables function.
* @param libraryLevel Default false, when set true plot will be based on library stats instead of sample stats */
* @param sampleId Default it selects all sampples, when sample is giving it limits to selected sample
*/
def rnaHistogramPlot(outputDir: File, def rnaHistogramPlot(outputDir: File,
prefix: String, prefix: String,
rnaHistogramPlotTables: Array[Map[String, Array[Any]]], rnaHistogramPlotTables: Array[Map[String, Array[Any]]],
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment