diff --git a/.github/workflows/auto-format.yml b/.github/workflows/auto-format.yml index 0ade705..2b6401f 100644 --- a/.github/workflows/auto-format.yml +++ b/.github/workflows/auto-format.yml @@ -33,7 +33,6 @@ jobs: shell: Rscript {0} run: | rmarkdown::render("README.Rmd") - if (file.exists("README.html")) file.remove("README.html") - name: update CITATION.cff shell: Rscript {0} diff --git a/.gitignore b/.gitignore index 54f27cb..899278b 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ docs inst/doc /doc/ /Meta/ +/README.html diff --git a/README.Rmd b/README.Rmd index 7ee0e73..c0f0ca3 100644 --- a/README.Rmd +++ b/README.Rmd @@ -25,22 +25,31 @@ R package for downstream multi-omics analysis Designed for differential [RNA-seq](https://github.com/CCBR/RENEE) analysis or any data represented in a counts table. +See the website for more information, documentation, and examples: + ## Installation -You can install the development version of MOSuite from [GitHub](https://github.com/) with: +You can install the development version of MOSuite from [GitHub](https://github.com/CCBR/MOSuite) with: ```r # install.packages("devtools") devtools::install_github("CCBR/MOSuite") ``` +## Usage + +Please see the [introductory vignette](https://ccbr.github.io/MOSuite/articles/intro.html) +for a quick start tutorial. +Take a look at the [reference documentation](https://ccbr.github.io/MOSuite/reference/index.html) +for detailed information on each function in the package. +