diff --git a/README.Rmd b/README.Rmd index 2df3ec3..f2f6861 100644 --- a/README.Rmd +++ b/README.Rmd @@ -1,9 +1,7 @@ --- author: Tingwei Adeck date: '`r format(Sys.time(), "%B %d, %Y")`' -output: - html_document: - keep_md: true +output: github_document bibliography: grateful-refs.bib --- diff --git a/README.md b/README.md index 3b0e9ff..2c86bfa 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,26 @@ ---- -author: Tingwei Adeck -date: 'December 17, 2023' -output: - html_document: - keep_md: true -bibliography: grateful-refs.bib ---- +Tingwei Adeck +December 17, 2023 - - # tidyDenovix -[![Project status](https://www.repostatus.org/badges/latest/concept.svg)](https://github.com/AlphaPrime7/tidyDenovix/graphs/commit-activity) [![Project Status](https://www.repostatus.org/badges/latest/wip.svg)](https://github.com/AlphaPrime7/tidyDenovix/graphs/commit-activity) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/AlphaPrime7/tidyDenovix/graphs/commit-activity) +[![Project +status](https://www.repostatus.org/badges/latest/concept.svg)](https://github.com/AlphaPrime7/tidyDenovix/graphs/commit-activity) +[![Project +Status](https://www.repostatus.org/badges/latest/wip.svg)](https://github.com/AlphaPrime7/tidyDenovix/graphs/commit-activity) +[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/AlphaPrime7/tidyDenovix/graphs/commit-activity) -The goal of [`{tidyDenovix}`](https://github.com/AlphaPrime7/tidyDenovix) is to clean data obtained from the Denovix spectrophotometry instrument. This package should clean data for RNA or DNA samples. At the moment users should use the 'lax' option for quality control. +The goal of +[`{tidyDenovix}`](https://github.com/AlphaPrime7/tidyDenovix) is to +clean data obtained from the Denovix spectrophotometry instrument. This +package should clean data for RNA or DNA samples. At the moment users +should use the ‘lax’ option for quality control. ## Installation -You can install the development version of tidyDenovix from [GitHub](https://github.com/AlphaPrime7/tidyDenovix) with: +You can install the development version of tidyDenovix from +[GitHub](https://github.com/AlphaPrime7/tidyDenovix) with: ``` r # install.packages("devtools") @@ -28,21 +29,33 @@ devtools::install_github("AlphaPrime7/tidyDenovix") ## Raison-Etre -- Upon using the Denovix, the user can take screenshots of the screen if they intend to present this data at a conference or seminar. However, the screenshots taken are not very professional and will likely not look good at a conference. -- As an undergraduate student I was faced with this issue and with poor programming skills, I had a hodgepodge of code lines that created an image but was not reproducible even by me because I had no idea what I was doing. -- Fast forward today and this package will accomplish cleaning this type of data making it ready for plotting and presenting to faculty and peers. -- Use the normalization parameter to find abnormal samples, meaning this package can be used to detect quality RNA isolates. This readme document will provide some code for plotting and enjoying visualizations while also accounting for quality of RNA isolates. +- Upon using the Denovix, the user can take screenshots of the screen if + they intend to present this data at a conference or seminar. However, + the screenshots taken are not very professional and will likely not + look good at a conference. +- As an undergraduate student I was faced with this issue and with poor + programming skills, I had a hodgepodge of code lines that created an + image but was not reproducible even by me because I had no idea what I + was doing. +- Fast forward today and this package will accomplish cleaning this type + of data making it ready for plotting and presenting to faculty and + peers. +- Use the normalization parameter to find abnormal samples, meaning this + package can be used to detect quality RNA isolates. This readme + document will provide some code for plotting and enjoying + visualizations while also accounting for quality of RNA isolates. ## Quality Control -- As always quality is important so there are some quality parameters. Play around with the check_level parameter as 'lax' vs 'strict' to determine the level of quality needed for the final output. +- As always quality is important so there are some quality parameters. + Play around with the check_level parameter as ‘lax’ vs ‘strict’ to + determine the level of quality needed for the final output. ## Example-Base This is a basic example which shows you how to solve a common problem: - -```r +``` r library(tidyDenovix) ## basic example code fpath <- system.file("extdata", "rnaspec2018.csv", package = "tidyDenovix", mustWork = TRUE) @@ -51,10 +64,10 @@ rna_data = tidyDenovix(fpath, file_type = 'csv', sample_type = 'RNA', check_leve ## Example-Normalized -This examples implements normalization for Quality Control of RNA isolates: +This examples implements normalization for Quality Control of RNA +isolates: - -```r +``` r library(tidyDenovix) ## basic example code fpath <- system.file("extdata", "rnaspec2018.csv", package = "tidyDenovix", mustWork = TRUE) @@ -63,14 +76,24 @@ rna_data = tidyDenovix(fpath, sample_type = 'RNA',check_level = 'strict', qc_omi ## Example-Plotting Data for QC visualization -- Visualization of normalized data for QC. Spectrophotometry can help in knowing if the sample in hand is RNA vs DNA but that is not the most sound approach. More will be discussed below on this. - -- Simply look for samples that look different and "viola" those are your problems. These samples will not be primed candidates for cDNA synthesis and most likely not useful for qPCR. +- Visualization of normalized data for QC. Spectrophotometry can help in + knowing if the sample in hand is RNA vs DNA but that is not the most + sound approach. More will be discussed below on this. -- The other aspect of QC will be ensuring that the kit used in RNA isolation is the right kit and actually yields RNA. This can only be done using gel electrophoresis and this is NOT the scope of this package OR is it even possible using this package. The user will need to physically run gels and confirm the presence of rRNA bands. In fact, it is resource smart to run gels first to confirm you have the right type of sample before determining if the samples meet the right quality needed for further probing. +- Simply look for samples that look different and “viola” those are your + problems. These samples will not be primed candidates for cDNA + synthesis and most likely not useful for qPCR. +- The other aspect of QC will be ensuring that the kit used in RNA + isolation is the right kit and actually yields RNA. This can only be + done using gel electrophoresis and this is NOT the scope of this + package OR is it even possible using this package. The user will need + to physically run gels and confirm the presence of rRNA bands. In + fact, it is resource smart to run gels first to confirm you have the + right type of sample before determining if the samples meet the right + quality needed for further probing. -```r +``` r library(tidyDenovix) ## basic example code fpath <- system.file("extdata", "rnaspec2018.csv", package = "tidyDenovix", mustWork = TRUE) @@ -105,17 +128,15 @@ saveWidget(ggplotly(rnaqcplot), file = "rnaplot.html", selfcontained = F, libdir ggplotly(rnaqcplot) ``` + -```{=html} -
- -``` - - -- The image above clearly shows that no samples were trying to be mavericks and all the samples behave similarly. All the samples above are quality samples at least based on spectrophotometry and ONLY gel electrophoresis rRNA band intensity can tell more about sample quality. +- The image above clearly shows that no samples were trying to be + mavericks and all the samples behave similarly. All the samples above + are quality samples at least based on spectrophotometry and ONLY gel + electrophoresis rRNA band intensity can tell more about sample + quality. - -```r +``` r #PLOT dark mode-rnaspec2018.csv 'strict' library(ggplot2) library(plotly) @@ -143,19 +164,48 @@ saveWidget(ggplotly(rnaqcplot), file = "rnaplot.html", selfcontained = F, libdir ggplotly(rnaqcplot) ``` - -```{=html} - - -``` - + ## Conclusion -- Finally, a programmatic solution to the problem of RNA quality checking. -- As always, credit to the Denovix team for making a machine that performs RNA QC checking. As always, these products come within their scope and programmers like me have to push this envelope in order to gain insight on these experiments hence tidyDenovix. -- Thanks for the support in advance, on to the next one. +- Finally, a programmatic solution to the problem of RNA quality + checking. +- As always, credit to the Denovix team for making a machine that + performs RNA QC checking. As always, these products come within their + scope and programmers like me have to push this envelope in order to + gain insight on these experiments hence tidyDenovix. +- Thanks for the support in advance, on to the next one. ## References -[@datatable] [@janitor] [@tidyverse] +(Dowle and Srinivasan 2023) (Firke 2023) (Wickham et al. 2019) + +