Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AliSajid committed Jan 31, 2021
1 parent 5df081f commit 72399bb
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 0 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
^renv\.lock$
^.*\.Rproj$
^\.Rproj\.user$
^README\.Rmd$
50 changes: 50 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# KINNET

<!-- badges: start -->
<!-- badges: end -->

This package provides the functionality to process PamGene's PamChip
Data Output and generate kinase interaction networks from that.

This project uses a bayesian algorithm to generate bayesian networks for
defining dependence relationships between peptide sequences in the PamChip data.
It then uses a novel kinase assignment method to assign upstream kinases to each
peptide which is then output as a graph.

## Installation

You can install the released version of KINNET from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("KINNET")
```

You can install the latest development version of KINNET from [Github]() with:

``` r
remotes::install_github("AliSajid/KINNET")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
#library(KINNET)
## basic example code
```
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# KINNET

<!-- badges: start -->
<!-- badges: end -->

This package provides the functionality to process PamGene’s PamChip
Data Output and generate kinase interaction networks from that.

This project uses a bayesian algorithm to generate bayesian networks for
defining dependence relationships between peptide sequences in the
PamChip data. It then uses a novel kinase assignment method to assign
upstream kinases to each peptide which is then output as a graph.

## Installation

You can install the released version of KINNET from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("KINNET")
```

You can install the latest development version of KINNET from [Github]()
with:

``` r
remotes::install_github("AliSajid/KINNET")
```

## Example

This is a basic example which shows you how to solve a common problem:

``` r
#library(KINNET)
## basic example code
```

0 comments on commit 72399bb

Please sign in to comment.