Skip to content

Commit

Permalink
1. Updated README to install dependencies too.
Browse files Browse the repository at this point in the history
2. Updated the right vignette.
  • Loading branch information
Bharath Air committed Jun 2, 2022
1 parent be6f7f7 commit 4dec1e2
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ BiocManager::install(c("SummarizedExperiment", "DESeq2", "edgeR", "limma", "rain
install.packages("devtools") # if it is not already installed
devtools::install_github("cran/npsm") # Package archived by CRAN
devtools::install_github("cran/DODR") # Package archived by CRAN
devtools::install_github("bharathananth/compareRhythms", build_vignettes = TRUE)
devtools::install_github("bharathananth/compareRhythms", build_vignettes = TRUE, dependencies = TRUE)
```

## Usage summary
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<!-- badges: start -->

[![](https://img.shields.io/badge/devel%20version-0.99.3-green.svg)](https://github.com/compareRhythms)
[![](https://img.shields.io/badge/devel%20version-1.0.0-green.svg)](https://github.com/compareRhythms)
[![License:
GPL-3](https://img.shields.io/badge/license-GPL--3-blue.svg)](https://cran.r-project.org/web/licenses/GPL-3)
[![](https://app.codecov.io/gh/bharathananth/compareRhythms/branch/master/graph/badge.svg)](https://app.codecov.io/gh/bharathananth/compareRhythms)
Expand All @@ -30,7 +30,7 @@ BiocManager::install(c("SummarizedExperiment", "DESeq2", "edgeR", "limma", "rain
install.packages("devtools") # if it is not already installed
devtools::install_github("cran/npsm") # Package archived by CRAN
devtools::install_github("cran/DODR") # Package archived by CRAN
devtools::install_github("bharathananth/compareRhythms", build_vignettes = TRUE)
devtools::install_github("bharathananth/compareRhythms", build_vignettes = TRUE, dependencies = TRUE)
```

## Usage summary
Expand Down
9 changes: 8 additions & 1 deletion vignettes/UserGuide.Rmd
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Analyzing rhythmic data with compareRhythms"
author: Bharath Ananthasubramaniam
date: 23 Oct 2020
date: 02 Jun 2022
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Analyzing rhythmic data with compareRhythms}
Expand Down Expand Up @@ -93,6 +93,13 @@ The different approaches can be divided into model selection and the rest that a
+ `length` (see **DESeq2**)

<u>Use cases</u>: This method is to be used with count data from an RNA-seq experiment. Count data from aligment (STAR, TopHat2) followed by quantification (htseq-count, summarizeOverlaps, featureCounts) can be directly used. If [tximport](https://doi.org/doi:10.18129/B9.bioc.tximport) is used to import data, then use `counts` and `length` obtained from the `tximport()` call with `countsFromAbundance = "no"`.

7. **Cosinor** (`method = "cosinor"`): This implements the simple classical **cosinor** analysis and includes an option to deal with longitudinal data (which is common in data from human studies).
+ `rhythm_fdr` (see **limma**)
+ `compare_fdr` (see **limma**)
+ `longitudinal` is a boolean to switch between *independent* time samples (FALSE, default) or *repeated-measures* samples (TRUE).

<u>Use cases</u>: This method can be used for any normalized dataset of moderate size (few hundreds of features). This analysis assumes that noise in the data is Gaussian and that there are no trends in the measurements across time. The `longitudinal = TRUE` requires the user to provide a factor column `ID` in the `exp_design` with the identity of each experimental unit that is repeatedly measured (Note: this analysis uses mixed-model framework of [lme4](https://cran.r-project.org/package=lme4)).

### Example 1: Microarray data
We analyze first the microarray data on the changes in circadian liver transcriptome under high fat diet (HFD) with respect to normal chow (NC) [@eckel-mahan_reprogramming_2013]. This data is provided with this package as a 23060x36 matrix called `high_fat_diet_ma`. Liver transcripts were quantified every 4h for 24h (6 samples) and the 2 different conditions with 3 biological replicates each (36=6x2x3). [maEndToEnd](https://bioconductor.org/packages/devel/workflows/vignettes/maEndToEnd/inst/doc/MA-Workflow.html) describes how to perform quality control and normalization for microarrays.
Expand Down

0 comments on commit 4dec1e2

Please sign in to comment.