You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

93 lines
5.8 KiB

4 years ago
% AMR (for R)
4 years ago
# `AMR` (for R)
4 years ago
<img src="man/figures/logo.png" align="right" height="120px" />
5 years ago
### Not a developer? Then please visit our website []( to read about this package.
**It contains documentation about all of the included functions and also a comprehensive tutorial about how to conduct AMR analysis.**
5 years ago
## Development source
*NOTE: the original source code is on GitLab (, so you can report a bug at There is a mirror repository on GitHub ( As the mirror process is automated by GitLab, both repositories always contain the latest changes.*
This is the **development source** of `AMR`, a free and open-source [R package]( to simplify the analysis and prediction of Antimicrobial Resistance (AMR) and to work with microbial and antimicrobial properties by using evidence-based methods.
4 years ago
## Authors
Matthijs S. Berends <a href=""><img src="" height="16px"></a> <sup>1,2,a</sup>,
Christian F. Luz <a href=""><img src="" height="16px"></a> <sup>1,a</sup>,
4 years ago
Erwin E.A. Hassing<sup>2</sup>,
Corinna Glasner <a href=""><img src="" height="16px"></a> <sup>1,b</sup>,
Alex W. Friedrich <a href=""><img src="" height="16px"></a> <sup>1,b</sup>,
Bhanu N.M. Sinha <a href=""><img src="" height="16px"></a> <sup>1,b</sup>
4 years ago
<sup>1</sup> Department of Medical Microbiology, University of Groningen, University Medical Center Groningen, Groningen, the Netherlands - []( [](<br>
<sup>2</sup> Certe Medical Diagnostics & Advice, Groningen, the Netherlands - [](<br>
<sup>a</sup> Thesis dissertant<br>
4 years ago
<sup>b</sup> Thesis advisor
4 years ago
<a href=""><img src="man/figures/logo_rug.png" height="60px"></a>
<a href=""><img src="man/figures/logo_umcg.png" height="60px"></a>
<a href=""><img src="man/figures/logo_certe.png" height="60px"></a>
<a href=""><img src="man/figures/logo_eh1h.png" height="60px"></a>
<a href=""><img src="man/figures/logo_interreg.png" height="60px"></a>
5 years ago
## How to get this package
All stable versions of this package [are published on CRAN](, the official R network with a peer-reviewed submission process.
### Install from CRAN
[![CRAN_Badge](]( [![CRAN_Downloads](](
(Note: Downloads measured only by, this excludes e.g. the official [](
- <img src="" alt="RStudio favicon" height="20px"> Install using [RStudio]( (recommended):
- Click on `Tools` and then `Install Packages...`
- Type in `AMR` and press <kbd>Install</kbd>
4 years ago
- <img src="" alt="R favicon" height="20px"> Install in R directly:
4 years ago
- `install.packages("AMR")`
### Install from Zenodo
This package was also published on Zenodo (stable releases only):
4 years ago
### Install from GitLab
4 years ago
This is the latest **development version**. Although it may contain bugfixes and even new functions compared to the latest released version on CRAN, it is also subject to change and may be unstable or behave unexpectedly. Always consider this a beta version. All below 'badges' should be green:
4 years ago
Development Test | Result | Reference
--- | :---: | ---
All functions checked on Linux | [![pipeline status](]( | GitLab CI [[ref 1]](
4 years ago
All functions checked on Windows | [![AppVeyor_Build](]( | Appveyor Systems Inc. [[ref 2]](
4 years ago
Percentage of syntax lines checked | [![Code_Coverage](]( [![Code_Coverage](]( | Codecov LLC [[ref 3]](
If so, try it with:
4 years ago
4 years ago
5 years ago
## Copyright
4 years ago
4 years ago
This R package is licensed under the [GNU General Public License (GPL) v2.0]( In a nutshell, this means that this package:
5 years ago
- May be used for commercial purposes
- May be used for private purposes
4 years ago
- May **not** be used for patent purposes
5 years ago
- May be modified, although:
- Modifications **must** be released under the same license when distributing the package
- Changes made to the code **must** be documented
- May be distributed, although:
- Source code **must** be made available when the package is distributed
- A copy of the license and copyright notice **must** be included with the package.
- Comes with a LIMITATION of liability
- Comes with NO warranty