Skip to content

An R package for utilities to guide in-depth detection of circadian signals from omics time series data

License

Notifications You must be signed in to change notification settings

viktormiok/tigaRcycle

Repository files navigation

version GitHub code size in bytes GitHub issues

dependencies commit GitHub

Edit with Gitpod

tigaRcycle

Overview

The R-package tigaRcycle performs integrative detection of circadian signals in time series omics data, both sequencing counts RNAseq and continuous microarray data. The package offers a broad range of functions for visualisation of rithmic signals and comparison between different diets and time points. Also, pathway enrichment analysis and visualisation using different repositories can be performed comparing different conditions.

Note: if you have a choice to use either Windows or Unix/Linux, opt for the latter. tigaRcycle runs more efficiently under Unix/Linux than under Windows. NOTE: when running tigaRcycle you may see *** WARNINGS *** from INLA (e.g. on eigenvalues, or on convergence, or even something like 18500 Aborted...). They can currently not be suppressed, because they are produced by C-code. Please ignore them.

image

Installation

The package tigaRcycle depends on tigaR and on R >= 3.0.0 and is available from GitHub. This requires the package devtools:

devtools::install_github("viktormiok/tigaRcycle", build_vignettes=TRUE)

Please restart R before loading the package and its documentation:

library(tigaRcycle)
utils::help(tigaRcycle)
utils::vignette("tigaRcycle")

Docker

If your system configuration is making it difficult to install tigaRcycle natively, an alternative way to get tigaRcycle running is through a docker container.

Note: On Mac OS X, Docker Machine has Memory and CPU limits. To control it, please check instructions either for CLI or for Docker Desktop.

For building Docker image from the Dockerfile, download the Dockerfile (available in this repo) and run to following command to build it:

docker build -t tigaRcycle .

This will create a tigaRcycle docker image on your system (please be patient, as the build could take approximately 30-50 minutes to finish). You can then run it using the following command:

docker run -d -p 8787:8787 -e PASSWORD=pass --name tigaRcycle -it tigaRcycle

Data

Data required for identifying circadian rhythms in transcriptomics data have been deposited in the National Center for Biotechnology Information Gene Expression Omnibus (GEO) and are accessible through the GEO Series accession numbers:

Data type GEO number
mRNA Arrays GSE138079
RNA-Seq Not available yet

In order to access one of the data set for instance GSE138079 you need to run the code bellow. Unpacking the data requires tar and gunzip, which should already be available on most systems.

cd ../  #To get to the main github repo folder
mkdir -p data/tigaRcycle_data_analysis/
cd data/tigaRcycle_data_analysis/
wget ftp://ftp.ncbi.nlm.nih.gov/geo/series/GSE13nnn/GSE138079/suppl/GSE138079_RAW.tar
mkdir GSE138079_RAW
tar -C GSE138079_RAW -xvf GSE138079_RAW.tar
gunzip GSE138079_RAW/*_Regional_*

Tutorials

Please see the following tutorials for detailed examples of how to use tigaRcycle:

tigaRcycle walkthrough:

License

tigaRcycle is distributed under the MIT license. Please read the license before using tigaRcycle, which it is distributed in the LICENSE file.

References

Publication related to tigaRcycle include:

Please cite the relevant publication if you use tigaRcycle.

About

An R package for utilities to guide in-depth detection of circadian signals from omics time series data

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published