R/setInfo.R

In Solatar/setR:

# Install Package: Ctrl + Shift + B
# devtools::document()

setInfo <- function(){
  cat("
  Organizing own datasets:
  setRead   |||takes: table        |||returns: identifiers       |
  setMake   |||takes: identifiers  |||returns: geneset           |
  setSave   |||takes: genesets     |||returns: a .gmt file       |
  setGet    |||takes: a .gmt file  |||returns: list              |
  setShared |||takes: list         |||returns: overlaping genes  |
  setCheck  |||takes: list & genes |||returns: gene presence info|
  ---
  Access the Cancer Genomics Data Server
  setCGbase    |||takes: nothing      |||returns: cgds object    |
  setCGstudy   |||takes: cgds object  |||returns: study ID       |
  setCGclinic  |||takes: cgds & study |||returns: clininc data   |
  setCGsurvival|||takes: clininc data |||returns: survival data  |
  ---
  Access the depmap database
  deepFilter |||takes: attribute specifics|||gives: cell line table      |
  deepResult |||takes: deepFilter output  |||gives: data about cell lines|
  deepPCA    |||takes: deepResults output |||gives: PCA                  |
  ---
  Vizualize in networks
  setNet     |||takes: genes & sets   |||returns: gene network    |
  setNetStyle|||takes: setNet output  |||returns: enhanced network|
  setNetGSEA |||takes: seekGSEA output|||returns: GSEA network    |
      ")
}