Skip to content

Commit

Permalink
Minor update to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ruthkr committed Mar 24, 2024
1 parent c681858 commit ce210a9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
6 changes: 4 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ knitr::opts_chunk$set(
[![GitHub last commit](https://img.shields.io/github/last-commit/ruthkr/greatR)](https://github.com/ruthkr/greatR/commits/master)
<!-- badges: end -->

`greatR` (**G**ene **R**egistration from **E**xpression **a**nd **T**ime-courses in **R**) is a tool to register (align) two sets of gene expression profiles that users wish to compare. These gene profiles data will be referred as the query and the reference data. To match the ranges over time between those profiles, the timepoints of the query gene expression profiles will be transformed through stretching and shifting process. This tool uses a statistical model comparison based on a Bayesian approach to evaluate the optimality of the gene expression profiles alignment.
`greatR` (**G**ene **R**egistration from **E**xpression **a**nd **T**ime-courses in **R**) is a tool to register (align) two sets of gene expression profiles that users wish to compare.

These gene profiles data will be referred as the **query** and the **reference** data. To match the time point ranges between those profiles, the time points of the **query** profiles will be transformed through a stretching and shifting process. This tool uses a statistical model comparison based on a Bayesian approach to evaluate the optimality of the gene expression profiles alignment.

## Package workflow

Expand All @@ -34,7 +36,7 @@ The flowchart below illustrates the workflow of the package given an input data:
knitr::include_graphics("man/figures/greatR_workflow.png")
```

More details on how to use this package are available on function documentations and the following vignettes:
More details on how to use this package are available on [function documentations](https://ruthkr.github.io/greatR/reference/index.html) and the following vignettes:

1. [Input data requirements](https://ruthkr.github.io/greatR/articles/data-requirement.html)
2. [Register data](https://ruthkr.github.io/greatR/articles/register-data.html)
Expand Down
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@ commit](https://img.shields.io/github/last-commit/ruthkr/greatR)](https://github

`greatR` (**G**ene **R**egistration from **E**xpression **a**nd
**T**ime-courses in **R**) is a tool to register (align) two sets of
gene expression profiles that users wish to compare. These gene profiles
data will be referred as the query and the reference data. To match the
ranges over time between those profiles, the timepoints of the query
gene expression profiles will be transformed through stretching and
shifting process. This tool uses a statistical model comparison based on
a Bayesian approach to evaluate the optimality of the gene expression
profiles alignment.
gene expression profiles that users wish to compare.

These gene profiles data will be referred as the **query** and the
**reference** data. To match the time point ranges between those
profiles, the time points of the **query** profiles will be transformed
through a stretching and shifting process. This tool uses a statistical
model comparison based on a Bayesian approach to evaluate the optimality
of the gene expression profiles alignment.

## Package workflow

Expand All @@ -31,8 +32,9 @@ input data:

<img src="man/figures/greatR_workflow.png" width="100%" />

More details on how to use this package are available on function
documentations and the following vignettes:
More details on how to use this package are available on [function
documentations](https://ruthkr.github.io/greatR/reference/index.html)
and the following vignettes:

1. [Input data
requirements](https://ruthkr.github.io/greatR/articles/data-requirement.html)
Expand Down

0 comments on commit ce210a9

Please sign in to comment.