Network fingerprint: a knowledge-based characterization of biomedical networks
Clone or download
yiluheihei yiluheihei
Latest commit 9b72e11 Dec 2, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R delete .DS_Store Dec 2, 2016
data delete .DS_Store Dec 2, 2016
docs delete .DS_Store Dec 2, 2016
inst/extdata delete .DS_Store Dec 2, 2016
man delete .DS_Store Dec 2, 2016
tests delete .DS_Store Dec 2, 2016
vignettes delete .DS_Store Dec 2, 2016
.Rbuildignore add travis.yml Nov 19, 2016
.gitignore add .DS_Store Dec 2, 2016
.travis.yml add codecov Nov 22, 2016
DESCRIPTION add the doi of the cited method Nov 21, 2016
NAMESPACE cran released Aug 31, 2016
NFP.Rproj dev version Oct 26, 2015
README.md remove latex syntax Dec 2, 2016
_pkgdown.yml customize template Nov 22, 2016

README.md

NFP: Network fingerprint analysis in R

Travis-CI Build Status CRAN_Status_Badge Coverage Status

This package implements the network fingerprint framework. A biomedical network is characterized as a spectrum-like vector called “network fingerprint”, which contains similarities to basic networks. This knowledge-based multidimensional characterization provides a more intuitive way to decipher molecular networks, especially for large-scale network comparisons and clustering analyses

Prerequisites

NFP is free available on CRAN. To install NFP, please note especially two depencies of NFP, graph and KEGGgraph are only available from Bioconductor. Appanrantly, function install.packages can not insall Biocondutor packages. There is a function biocLite, a wrapper around install.packages provided by Bioconductor, can be used to install both CRAN and Bioconductor packages simply. More details on biocLite is available from https://www.bioconductor.org/install/#why-biocLite. Thus, users can install NFP install the latest released version using biocLite directly:

source("http://bioconductor.org/biocLite.R")
biocLite("NFP")

or install the Bioconductor dependencies package first:

biocLite(c("graph","KEGGgraph"))
install.packages("NFP")

It also allows users to install the latest development version from github, which requires devtools package has been installed on your system (or can be installed using install.packages("devtools")). Note that devtools sometimes needs some extra non-R software on your system -- more specifically, an Rtools download for Windows or Xcode for OS X. There's more information about devtools here.

## install NFP from github, require biocondutor dependencies package pre-installed
if (!require(devtools) 
  install.packages("devtools") 
devtools::install_github("yiluheihei/NFP") 

After installation, you can load NFP into current workspace by typing or pasting the following codes:

library("NFP")

Moreover, gene similarity data used in our NFP package is stored in a external data repository NFPdata for the large size (about 16 MB). More details on how to construct External Data Repositories using the Additional_repositories field see The Coatless Professor blog post. Thus, users must install the NFPdata before the networkfinger print analyis as following code.

if (!require("NFPdata")) {
    install_data_package()
}

Contributing

For very simple changes such as fixing typos, you can just edit the file by clicking the button Edit. For more complicated changes, you will have to manually create a pull request after forking this repository.

License

NFP is a free and open source software, licensed under GPL 2.0.

Reference

Cui X, He H, He F, et al. Network fingerprint: a knowledge-based characterization of biomedical networks. Scientific reports, 2015, 5.