R/plot_per_read_quality.R

Defines functions plot_per_read_quality

Documented in plot_per_read_quality

#' Plot the mean quality score per sequence as a histogram.
#' High quality sequences are those mostly distributed over 30.
#' Low quality sequences are those mostly under 30.
#' \code{plot_per_read_quality}
#' @param prq Data frame from per_read_quality function
#' @param output_file File to write plot to. Will not write to file if NA. Default NA.
#' @examples
#' infile <- system.file("extdata", "10^5_reads_test.fq.gz", package = "qckitfastq")
#' prq <- per_read_quality(infile)
#' plot_per_read_quality(prq)
#' @return Plot of mean quality score per read
#' @export
plot_per_read_quality <- function(prq,output_file=NA){
  p1 <- ggplot2::ggplot(data=prq,
                        ggplot2::aes(.data$sequence_mean)) +
    ggplot2::geom_histogram(bins=30)
  p_perseq_quality <- p1 +
    ggplot2::labs(title="Histograms of per sequence mean quality",
                  x= "Mean Quality Score",
                  y = "Frequency")
  if (!is.na(output_file)){ggplot2::ggsave(file=output_file,p_perseq_quality)}

  return(p_perseq_quality)
}
compbiocore/qckitfastq documentation built on Sept. 20, 2019, 9:30 a.m.