MD-Anderson-Bioinformatics / NGCHM-R

An R library for creating Next-Generation Clustered Heat Maps (NG-CHM)
http://bioinformatics.mdanderson.org/main/NG-CHM-V2:Overview
7 stars 3 forks source link

Add vignettes and pkgdown website #19

Closed marohrdanz closed 3 years ago

marohrdanz commented 3 years ago

This pull request adds vignettes and infrastructure for a pkgdown website.

A few things to mention:

If/After this PR is accepted, there are some steps to take to set up the pkgdown site:

  1. Change the url in _pkgdown.yml file to https://MD-Anderson-Bioinformatics.github.io/NGCHM-R/

  2. Change the GitHub href at the bottom of _pkgdown.yml to https://github.com/MD-Anderson-Bioinformatics/NGCHM-R/

  3. Set up empty gh-pages branch. Example commands:

    git checkout --orphan gh-pages
    git rm -rf .
    git commit --allow-empty -m 'Initial gh-pages commit'
    git push origin gh-pages
    git checkout master
  4. Configure GitHub Pages to use 'gh-pages' branch at the root level.

    • Follow GitHub's documentation for this
marohrdanz commented 3 years ago

Thanks @ChrisWakefield . I think the commits can be squashed during the merge.