Diff of /R/INDEED.R [000000] .. [3bfed4]

Switch to unified view

a b/R/INDEED.R
1
#' INDEED: A network-based method for cacner biomarker discovery.
2
#'
3
#' The INDEED R package provides important functions as shown below:
4
#' non_partial_cor(), select_rho_partial(), partial_cor(), and network_display().
5
#'
6
#' @section non_partial_cor function:
7
#' non_partial_cor function performs typical correlation analysis
8
#' based on user input data, class label, p-value, sample id,
9
#' number of permutations, and the method (default pearson)
10
#' p value is optional,
11
#' the result of score table and differential network will be returned
12
#'
13
#' @section select_rho_partial function:
14
#' select_rho_partial function preprocesses data for partical correlation analysis,
15
#' the result contains list of preprocessed data and rho values and
16
#' error plot for user to choose desired rho value for graphical lasso
17
#'
18
#' @section partial_cor function:
19
#' partial_cor function performs partical correlation analysis
20
#' based on user input preprocessed list from select_rho_partial step
21
#' and the rho choosing method or values of their choice
22
#' and number of permutations (default 1000), p-value is optional,
23
#' the result of score table and differential network will be returned
24
#'
25
#' @section network_display function:
26
#' A function to assist in the network visualization of the result from INDEED functions 
27
#' non_partial_cor() and patial_cor().
28
#'
29
#' @docType package
30
#' @name INDEED
31
NULL