Skip to content

Commit 2bd9e8d

Browse files
committed
Update README.md
1 parent c70f00e commit 2bd9e8d

3 files changed

Lines changed: 27 additions & 21 deletions

File tree

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Date: 2020-02-04
1+
Date: 2020-02-20
22
Package: canprot
3-
Version: 0.1.4-61
3+
Version: 0.1.5
44
Title: Compositional Analysis of Differentially Expressed Proteins in Cancer and Cell Culture
55
Authors@R: c(
66
person("Jeffrey", "Dick", email = "j3ffdick@gmail.com", role = c("aut", "cre"),

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,19 @@
22

33
# canprot
44

5-
Datasets are collected here for differentially (up- and down-)
6-
expressed proteins identified in proteomic studies of cancer and in cell
7-
culture experiments. Tables of amino acid compositions of proteins are
8-
used for calculations of chemical composition, projected into selected
9-
basis species. Plotting functions are used to visualize the compositional
10-
differences and thermodynamic potentials for proteomic transformations.
5+
Compositional analysis of differentially expressed proteins in cancer and cell
6+
culture proteomics experiments. The data include lists of up- and
7+
down-regulated proteins in different types of cancer (colorectal, pancreatic,
8+
breast, lung, prostate) and laboratory conditions (hypoxia, hyperosmotic
9+
stress, 3D cell culture, and proteins secreted in hypoxia), together with amino
10+
acid compositions calculated for protein sequences from UniProt. Functions are
11+
provided to compute compositional metrics including protein length, carbon
12+
oxidation state, and stoichiometric hydration state. In addition, phylostrata
13+
(evolutionary ages) of protein-coding genes are available using data from
14+
[Liebeskind et al. (2016)](https://doi.org/10.1093/gbe/evw113) or [Trigos et
15+
al. (2017)](https://doi.org/10.1073/pnas.1617743114). The vignettes show
16+
references and plots of differences of chemical composition and phylostrata for
17+
all datasets.
1118

1219
For more information, see two papers in *PeerJ* ([2016](http://doi.org/10.7717/peerj.2238)
1320
and [2017](http://doi.org/10.7717/peerj.3421)).
@@ -23,26 +30,27 @@ install.packages("canprot")
2330

2431
## Installation from Github
2532

26-
First install the **devtools** package from CRAN:
33+
First install the **remotes** package from CRAN:
2734

2835
```R
29-
install.packages("devtools")
36+
install.packages("remotes")
3037
```
3138

3239
Then install **canprot** from Github:
3340

3441
```R
35-
devtools::install_github("jedick/canprot")
42+
remotes::install_github("jedick/canprot")
3643
```
3744

38-
## Building vignettes
45+
This also installs the **CHNOSZ** and **xtable** packages.
3946

40-
To install the package including the vignettes:
47+
### Building vignettes
48+
49+
Building the vignettes requires [pandoc](http://pandoc.org/installing.html) on the system.
50+
To install the package with the vignettes:
4151

4252
```R
43-
devtools::install_github("jedick/canprot", build_vignettes = TRUE)
53+
remotes::install_github("jedick/canprot", dependencies = TRUE, build_vignettes = TRUE)
4454
```
4555

46-
You may need to re-run this command one or more times. Note that this pulls in
47-
more R packages as dependencies, and [pandoc](http://pandoc.org/installing.html)
48-
is also required.
56+
This installs more R packages as dependencies (particularly **knitr** and **rmarkdown**).

inst/NEWS

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
CHANGES IN canprot 0.1.4-54 (2020-01-17)
2-
----------------------------------------
3-
4-
- Change license from GPL-3 to MIT.
1+
CHANGES IN canprot 0.1.5 (2020-02-20)
2+
-------------------------------------
53

64
- Rename check_ID() to check_IDs() and add 'IDcol' argument. The
75
function now uses a data frame for input and output.

0 commit comments

Comments
 (0)