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

Address initial issues after pkgdown setup #20

Closed marohrdanz closed 2 years ago

marohrdanz commented 2 years ago

This pull request addresses a few issues after the pgkdown GitHub Pages setup:

  1. README.md not showing up on the GitHub project page.
    • The README for the GitHub Pages pgkdown site isn't appropriate for the GitHub Project site anyways
    • This PR uses index.md file for the pkdown site
    • A separate README.md is used for the GitHub Project page, and includes a link to the pkgdown site
  2. Added linkouts to the example NG-CHM on the home page of the GitHub Pages site.
marohrdanz commented 2 years ago

I verified these changes regarding index.md and README.md fix the issue described in this PR (verified in my fork of this project).