Skip to content

Commit

Permalink
tidy up readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
pboesu committed Aug 23, 2023
1 parent 471433e commit 89774ad
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 25 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ knitr::opts_chunk$set(

<!-- badges: start -->
[![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)
Expand Down Expand Up @@ -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.
36 changes: 14 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
rucrdtw - R Bindings for the UCR Suite
======================================
# rucrdtw - R Bindings for the UCR Suite

<!-- badges: start -->

[![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)
<!-- badges: end -->

Expand All @@ -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:

Expand All @@ -28,8 +26,7 @@ install.packages("devtools")
devtools::install_github("pboesu/rucrdtw")
```

Examples
--------
## Examples

Examples are contained in the vignette `rucrdtw`:

Expand All @@ -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
<a href="http://doi.org/10.21105/joss.00100" class="uri">http://doi.org/10.21105/joss.00100</a>
The Journal of Open Source Software <http://doi.org/10.21105/joss.00100>

Rakthanmanon et al. (2012). Searching and mining trillions of time
series subsequences under dynamic time warping. SIGKDD
<a href="http://doi.org/10.1145/2339530.2339576" class="uri">http://doi.org/10.1145/2339530.2339576</a>
<http://doi.org/10.1145/2339530.2339576>

Bug reports and contributions
-----------------------------
## Bug reports and contributions

Please file a github issue at
<a href="https://github.com/pboesu/rucrdtw/issues" class="uri">https://github.com/pboesu/rucrdtw/issues</a>
Please file a github issue at <https://github.com/pboesu/rucrdtw/issues>
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
<a href="mailto:[email protected]" class="email">[email protected]</a>.
<[email protected]>.

License
-------
## License

COPYRIGHT 2012: Thanawin Rakthanmanon, Bilson Campana, Abdullah Mueen,
Gustavo Batista and Eamonn Keogh. (UCR Suite source code)
Expand All @@ -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

<a href="http://www.apache.org/licenses/LICENSE-2.0" class="uri">http://www.apache.org/licenses/LICENSE-2.0</a>
<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,
Expand Down
Binary file modified inst/img/dtw-comparison-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion vignettes/rucrdtw.bib
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 89774ad

Please sign in to comment.