{"Type":"Package","Package":"tsmp","Title":"Time Series with Matrix Profile","Version":"0.4.15","Authors@R":"c(person(given = \"Francisco\",\nfamily = \"Bischoff\",\nrole = c(\"aut\", \"cre\"),\nemail = \"fbischoff@med.up.pt\",\ncomment = c(ORCID = \"https://orcid.org/0000-0002-5301-8672\")),\nperson(given = \"Michael\",\nfamily = \"Yeh\",\nrole = c(\"res\", \"ccp\", \"ctb\"),\nemail = \"myeh003@ucr.edu\",\ncomment = c(ORCID = \"https://orcid.org/0000-0002-9807-2963\")),\nperson(given = \"Diego\",\nfamily = \"Silva\",\nrole = c(\"res\", \"ccp\", \"ctb\"),\nemail = \"diegofs@ufscar.br\",\ncomment = c(ORCID = \"https://orcid.org/0000-0002-5184-9413\")),\nperson(given = \"Yan\",\nfamily = \"Zhu\",\nrole = c(\"res\", \"ccp\", \"ctb\"),\nemail = \"yzhu015@ucr.edu\",\ncomment = c(ORCID = \"https://orcid.org/0000-0002-5952-2108\")),\nperson(given = \"Hoang\",\nfamily = \"Dau\",\nrole = c(\"res\", \"ccp\", \"ctb\"),\nemail = \"hdau001@ucr.edu\",\ncomment = c(ORCID = \"https://orcid.org/0000-0003-2439-5185\")),\nperson(given = \"Michele\",\nfamily = \"Linardi\",\nrole = c(\"res\", \"ccp\", \"ctb\"),\nemail = \"michele.linardi@orange.fr\",\ncomment = c(ORCID = \"https://orcid.org/0000-0002-3249-2068\")))","Maintainer":"Francisco Bischoff ","Description":"A toolkit implementing the Matrix Profile concept\nthat was created by CS-UCR\n.","License":"Apache License (>= 2.0)","URL":"https://github.com/matrix-profile-foundation/tsmp","BugReports":"https://github.com/matrix-profile-foundation/tsmp/issues","Depends":"R (>= 4.0)","Imports":"audio, checkmate, doSNOW, foreach, magrittr, parallel,\nprogress, Rcpp, RcppParallel (>= 5.0.0), RJSONIO","Suggests":"covr, gdtools, knitr, rmarkdown, raster, spelling, testthat\n(>= 2.1.0), vdiffr","LinkingTo":"Rcpp (>= 1.0.3), RcppParallel (>= 5.0.0)","VignetteBuilder":"knitr","Encoding":"UTF-8","Language":"en-US","LazyData":"true","NeedsCompilation":"yes","RoxygenNote":"7.2.1","SystemRequirements":"GNU make","Packaged":"2022-08-18 16:31:18 UTC; franz","Author":"Francisco Bischoff [aut, cre] (),\nMichael Yeh [res, ccp, ctb] (),\nDiego Silva [res, ccp, ctb] (),\nYan Zhu [res, ccp, ctb] (),\nHoang Dau [res, ccp, ctb] (),\nMichele Linardi [res, ccp, ctb]\n()","Repository":"CRAN","Date/Publication":"2022-08-20 22:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/tsmp_0.4.15.tar.gz","jsonAuthors":[{"name":"Francisco Bischoff","email":"fbischoff@med.up.pt","maintainer":true},{"name":"Michael Yeh","email":"myeh003@ucr.edu","maintainer":false},{"name":"Diego Silva","email":"diegofs@ufscar.br","maintainer":false},{"name":"Yan Zhu","email":"yzhu015@ucr.edu","maintainer":false},{"name":"Hoang Dau","email":"hdau001@ucr.edu","maintainer":false},{"name":"Michele Linardi","email":"michele.linardi@orange.fr","maintainer":false}],"readme":"README\n================\nFrancisco Bischoff\n- 18 Aug 2022\n\n\n\n

\n\n# Time Series with Matrix Profile\n\n\n[![Packagist](https://img.shields.io/badge/License-Apache--2.0-brightgreen.svg)](https://choosealicense.com/licenses/apache-2.0/)\n[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)\n[![CRAN\nversion](http://www.r-pkg.org/badges/version/tsmp)](https://cran.r-project.org/package=tsmp)\n[![CRAN\nDownloads](https://cranlogs.r-pkg.org/badges/tsmp)](https://cran.r-project.org/package=tsmp)\n[![CircleCI build\nstatus](https://circleci.com/gh/matrix-profile-foundation/tsmp.svg?style=svg)](https://app.circleci.com/pipelines/github/matrix-profile-foundation/tsmp)\n\n\n| | Build | Dev |\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Windows | [![AppVeyor build status](https://ci.appveyor.com/api/projects/status/byfyqncr60ten98g/branch/master?svg=true)](https://ci.appveyor.com/project/franzbischoff/tsmp/branch/master) | [![AppVeyor build status](https://ci.appveyor.com/api/projects/status/byfyqncr60ten98g/branch/develop?svg=true)](https://ci.appveyor.com/project/franzbischoff/tsmp/branch/develop) |\n| Coverage | [![codecov](https://codecov.io/gh/matrix-profile-foundation/tsmp/branch/master/graph/badge.svg)](https://app.codecov.io/gh/matrix-profile-foundation/tsmp) | [![codecov](https://codecov.io/gh/matrix-profile-foundation/tsmp/branch/develop/graph/badge.svg)](https://app.codecov.io/gh/matrix-profile-foundation/tsmp) |\n\n## Notice\n\nThis version is being maintained to keep up with CRAN standards. As soon\nas possible a new version (with possible breaking changes) with less\ndependencies will be released later in 2022 or beginning of 2023.\n\n## Overview\n\nR Functions implementing UCR Matrix Profile Algorithm\n().\n\nThis package allows you to use the Matrix Profile concept as a toolkit.\n\nThis package provides:\n\n- Algorithms to build a Matrix Profile: STAMP, STOMP, SCRIMP++,\n SIMPLE, MSTOMP and VALMOD.\n- Algorithms for MOTIF search for Unidimensional and Multidimensional\n Matrix Profiles.\n- Algorithm for Chains search for Unidimensional Matrix Profile.\n- Algorithms for Semantic Segmentation (FLUSS) and Weakly Labeled data\n (SDTS).\n- Algorithm for Salient Subsections detection allowing MDS plotting.\n- Basic plotting for all outputs generated here.\n- Sequencial workflow, see below.\n\n``` r\n# Basic workflow:\nmatrix <- tsmp(data, window_size = 30) %>%\n find_motif(n_motifs = 3) %T>%\n plot()\n\n# SDTS still have a unique way to work:\nmodel <- sdts_train(data, labels, windows)\nresult <- sdts_predict(model, data, round(mean(windows)))\n```\n\nPlease refer to the [User\nManual](https://matrixprofile.org/tsmp/reference/) for more details.\n\nPlease be welcome to suggest improvements.\n\n### Performance on an Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz using a random walk dataset\n\n``` r\nset.seed(2018)\ndata <- cumsum(sample(c(-1, 1), 40000, TRUE))\n```\n\n#### Current version benchmark\n\nWIP in this version\n\n## Installation\n\n``` r\n# Install the released version from CRAN\ninstall.packages(\"tsmp\")\n\n# Or the development version from GitHub:\n# install.packages(\"devtools\")\ndevtools::install_github(\"matrix-profile-foundation/tsmp\")\n```\n\n## Currently available Features\n\n- STAMP (single and multi-thread versions)\n- STOMP (single and multi-thread versions)\n- STOMPi (On-line version)\n- SCRIMP (single-thread, not for AB-joins yet)\n- Time Series Chains\n- Multivariate STOMP (mSTOMP)\n- Multivariate MOTIF Search (from mSTOMP)\n- Salient Subsequences search for Multidimensional Space\n- Scalable Dictionary learning for Time Series (SDTS) prediction\n- FLUSS (Fast Low-cost Unipotent Semantic Segmentation)\n- FLOSS (Fast Low-cost On-line Unipotent Semantic Segmentation)\n- SiMPle-Fast (Fast Similarity Matrix Profile for Music Analysis and\n Exploration)\n- Annotation vectors (e.g., Stop-word MOTIF bias, Actionability bias)\n- FLUSS Arc Plot and SiMPle Arc Plot\n- Exact Detection of Variable Length Motifs (VALMOD)\n- MPdist: Matrix Profile Distance\n- Time Series Snippets\n- Subsetting Matrix Profiles (`head()`, `tail()`, `[`, etc.)\n- Misc:\n - MASS v2.0\n - MASS v3.0\n - MASS extensions: ADP (Approximate Distance Profile, with PAA)\n - MASS extensions: WQ (Weighted Query)\n - MASS extensions: QwG (Query with Gap)\n - Fast moving average\n - Fast moving SD\n\n## Roadmap\n\n- Profile-Based Shapelet Discovery\n- GPU-STOMP\n\n## Other projects with Matrix Profile\n\n- Python: \n- Python: \n- Python: \n- Python: \n- Python: \n- R: \n- Matlab: \n- Java: \n- Java: \n- Kotlin: \n- C++ (CUDA and OPENCL): \n- CUDA: \n- CUDA: \n\n## Matrix Profile Foundation\n\nOur next step unifying the Matrix Profile implementation in several\nprogramming languages.\n\nVisit: [Matrix Profile Foundation](https://matrixprofile.org)\n\n## Package dependencies\n\n![](man/figures/dependency_plot-1.png)\n\n## Code of Conduct\n\nPlease note that the ‘tsmp’ project is released with a [Contributor Code\nof\nConduct](https://github.com/matrix-profile-foundation/tsmp/blob/master/.github/CODE_OF_CONDUCT.md).\nBy contributing to this project, you agree to abide by its terms.","jobInfo":{"package":"tsmp","version":"0.4.15","parsingStatus":"success","parserVersion":2,"parsedAt":"2022-08-21T00:31:31+0000"}}

Description

Usage

Arguments

Format