diff --git a/README.Rmd b/README.Rmd index fc051f9..b907384 100644 --- a/README.Rmd +++ b/README.Rmd @@ -19,7 +19,7 @@ knitr::opts_chunk$set( [![R-CMD-check](https://github.com/pboesu/rucrdtw/workflows/R-CMD-check/badge.svg)](https://github.com/pboesu/rucrdtw/actions) -[![codecov](https://codecov.io/gh/pboesu/rucrdtw/branch/master/graph/badge.svg)](https://codecov.io/gh/pboesu/rucrdtw) +[![codecov](https://codecov.io/gh/pboesu/rucrdtw/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pboesu/rucrdtw) [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rucrdtw)](https://cran.r-project.org/package=rucrdtw) [![Peer_Reviewed_Software](https://img.shields.io/badge/Peer%20Reviewed-%E2%9C%93-green.svg)](http://doi.org/10.21105/joss.00100) [![DOI:10.21105/joss.00100](https://img.shields.io/badge/DOI-10.21105%2Fjoss.00100-blue.svg)](http://doi.org/10.21105/joss.00100) @@ -102,6 +102,6 @@ COPYRIGHT 2016: Philipp Boersch-Supan (R bindings) Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at -http://www.apache.org/licenses/LICENSE-2.0 +https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. diff --git a/README.md b/README.md index 88c9146..ad529b7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ -rucrdtw - R Bindings for the UCR Suite -====================================== +# rucrdtw - R Bindings for the UCR Suite [![R-CMD-check](https://github.com/pboesu/rucrdtw/workflows/R-CMD-check/badge.svg)](https://github.com/pboesu/rucrdtw/actions) -[![codecov](https://codecov.io/gh/pboesu/rucrdtw/branch/master/graph/badge.svg)](https://codecov.io/gh/pboesu/rucrdtw) -[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/rucrdtw)](https://cran.r-project.org/package=rucrdtw) -[![Peer\_Reviewed\_Software](https://img.shields.io/badge/Peer%20Reviewed-%E2%9C%93-green.svg)](http://doi.org/10.21105/joss.00100) +[![codecov](https://codecov.io/gh/pboesu/rucrdtw/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pboesu/rucrdtw) +[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rucrdtw)](https://cran.r-project.org/package=rucrdtw) +[![Peer_Reviewed_Software](https://img.shields.io/badge/Peer%20Reviewed-%E2%9C%93-green.svg)](http://doi.org/10.21105/joss.00100) [![DOI:10.21105/joss.00100](https://img.shields.io/badge/DOI-10.21105%2Fjoss.00100-blue.svg)](http://doi.org/10.21105/joss.00100) @@ -18,8 +17,7 @@ is several orders of magnitudes faster than naive DTW searches. ![](inst/img/dtw-comparison-1.png) -Installation ------------- +## Installation Install `rucrdtw` from GitHub: @@ -28,8 +26,7 @@ install.packages("devtools") devtools::install_github("pboesu/rucrdtw") ``` -Examples --------- +## Examples Examples are contained in the vignette `rucrdtw`: @@ -38,33 +35,28 @@ library("rucrdtw") vignette("using_rucrdtw") ``` -Citation --------- +## Citation To cite rucrdtw in publications, please use: Boersch-Supan (2016). rucrdtw: Fast time series subsequence search in R. -The Journal of Open Source Software -http://doi.org/10.21105/joss.00100 +The Journal of Open Source Software Rakthanmanon et al. (2012). Searching and mining trillions of time series subsequences under dynamic time warping. SIGKDD -http://doi.org/10.1145/2339530.2339576 + -Bug reports and contributions ------------------------------ +## Bug reports and contributions -Please file a github issue at -https://github.com/pboesu/rucrdtw/issues +Please file a github issue at if you find any problems or have feature suggestions. Contributions (via pull requests or otherwise) are welcome. Read more about how to contribute and the code of conduct for contributions [here](https://github.com/pboesu/rucrdtw/blob/master/CONTRIBUTING.md). If you don’t like github you can contact the package maintainer at -. +. -License -------- +## License COPYRIGHT 2012: Thanawin Rakthanmanon, Bilson Campana, Abdullah Mueen, Gustavo Batista and Eamonn Keogh. (UCR Suite source code) @@ -75,7 +67,7 @@ Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at -http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, diff --git a/inst/img/dtw-comparison-1.png b/inst/img/dtw-comparison-1.png index 86871ba..51b3680 100644 Binary files a/inst/img/dtw-comparison-1.png and b/inst/img/dtw-comparison-1.png differ diff --git a/vignettes/rucrdtw.bib b/vignettes/rucrdtw.bib index 2c0cfa2..9320acf 100644 --- a/vignettes/rucrdtw.bib +++ b/vignettes/rucrdtw.bib @@ -17,7 +17,7 @@ @inproceedings{berndt1994using pages={359--370}, year={1994}, organization={AAAI}, - url={http://www.aaai.org/Library/Workshops/1994/ws94-03-031.php} + url={https://www.aaai.org/Library/Workshops/1994/ws94-03-031.php} } @article{Rcpp,