Skip to content

Commit

Permalink
docs: update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanbass authored Aug 29, 2024
1 parent f494e53 commit 7c66a0f
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,20 @@
Variable Penalty Dynamic Time Warping for aligning GC-MS chromatograms to a master signal and more. With the appropriate penalty this method performs good alignment without altering the shape of peaks in chromatography data.

## Installation
Please install the package in R directly using the commands:
The package can be installed from GitHub:

```R
install.packages("devtools")
devtools::install_github("david-clifford/VPdtw")
install.packages("remotes")
remotes::install_github("ethanbass/VPdtw")
```

or from R Universe:

```
install.packages("chromConverter", repos="https://ethanbass.r-universe.dev/")
```


## References
Clifford, D., Stone, G., Montoliu, I., Rezzi, S., Martin, F. P., Guy, P., ... & Kochhar, S. (2009). Alignment using variable penalty dynamic time warping. Analytical chemistry, 81(3), 1000-1007. doi:http://dx.doi.org/10.1021/ac802041e

Expand Down

0 comments on commit 7c66a0f

Please sign in to comment.