-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
82 lines (61 loc) · 2.87 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
```{r env, echo=FALSE}
knitr::opts_chunk$set(comment=NA)
```
`MSnbase` is an R/Bioconductor package that provides infrastructure
for plotting, data manipulation and processing of MS-based proteomics
data. The project was started by
[Laurent Gatto](http://lgatto.github.io/) in October 2010 (Mon Oct 4
23:35:23 2010, according to the git log) and has, since then,
benefited from various contributions.
```{r, echo=FALSE}
auth <- packageDescription("MSnbase")$Author
auth <- sub("<[email protected]> ", "", auth)
auth <- gsub("\n\t", "\n", auth)
auth <- gsub("\t", " ", auth)
cat(auth, "\n")
```
The official page is the Bioconductor landing page
([release](http://www.bioconductor.org/packages/release/bioc/html/MSnbase.html)
or
[devel](http://www.bioconductor.org/packages/devel/bioc/html/MSnbase.html)
versions). The [github page](https://github.com/lgatto/MSnbase) page
is for sharing, testing, issue tracking and forking/pulling
purposes. The
[Bioconductor svn server](https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/),
is the official repository for the working source code.
## Installation
To install `MSnbase`
```{r install, eval = FALSE}
library("BiocInstaller")
biocLite("MSnbase")
```
If you need the github version
```{r installgh, eval = FALSE}
biocLite("lgatto/MSnbase")
```
## Build status
[![Build Status](https://travis-ci.org/lgatto/MSnbase.svg?branch=master)](https://travis-ci.org/lgatto/MSnbase) [![codecov.io](https://codecov.io/github/lgatto/MSnbase/coverage.svg?branch=master)](https://codecov.io/github/lgatto/MSnbase?branch=master)
## Questions
General questions should be asked on the
[Bioconductor support forum](https://support.bioconductor.org/), using
`MSnbase` to tag the question.
## Citation
To cite the `MSnbase` package in publications, please use:
> Gatto L, Lilley KS. *`MSnbase` - an R/Bioconductor package for
> isobaric tagged mass spectrometry data visualization, processing and
> quantitation*. Bioinformatics. 2012 Jan
> 15;28(2):288-9. doi:[10.1093/bioinformatics/btr645](http://bioinformatics.oxfordjournals.org/content/28/2/288.long). Epub
> 2011 Nov 22. PubMed
> [PMID:22113085](http://www.ncbi.nlm.nih.gov/pubmed/22113085).
## Contributing
Contributions to the package are more than welcome. If you want to
contribute to this package, you should follow the same conventions as
the rest of the functions whenever it makes sense to do so. Feel free
to get in touch (preferable opening a
[github issue](https://github.com/lgatto/MSnbase/issues/)) to discuss
any suggestions. The
[`MSnbase` development vignette](http://bioconductor.org/packages/devel/bioc/vignettes/MSnbase/inst/doc/MSnbase-development.pdf)
gives some background on the class infrastructure.
Please note that this project is released with a
[Contributor Code of Conduct](https://github.com/lgatto/MSnbase/blob/master/CONDUCT.md). By
participating in this project you agree to abide by its terms.