Please refer to the vignette for details and examples on how to use this package!

There are two vignettes in this package that guide you through the process of using this software.

Check out whether the latest build has passed the checks on Tarvis/AppVeyor:

Travis-CI Build Status

Build status

Currently, testing covers this proportion of lines of code


How to build your own recognition function

Your function can have any name you wish. There are, however, a few criteria you should adhere to:

  1. EXT=extrema as passed to your function
  2. EXV=values of these extrema, as passed to your function
  3. EXP=position in time of these extremes
  4. RESULT=Logical. TRUE if any pattern is found in the sample, FALSE otherwise. Depending on whether your algorithm looks for more than one type of pattern, this needs to be programmed. If TRUE, slicer counts the result as a find.

Below is an example of a skeleton recognition function for your own patterns. ITALIC are optional but recommended elements.

custompatrec <- function(extrema, extvals, extpos, arguments){
    #room for your code
    result <- list(EXT=extrema, EXV=extvals, EXP=extpos, recog, RESULT=logical)
    #recog is your own output. I recommend a separate list
    #element per type of pattern your function recognises