Learn R Programming

About

This R package was made based in the article Generalização de Mineração de Sequências Restritas no Espaço e no Tempo, so its main goal is mining patterns present in spatio-temporal datasets. The R package was developed at CEFET/RJ for academic work.

In the next sections you can check an example of the running code, its documentation, development steps and so on. Please feel free to make contributions and contact in case of bugs/suggestions.

Example

This example is also present in example folder, just clone it to run it.

library("gstsm")

D <- as.data.frame(matrix(c("B", "B", "A", "C", "A",
                      "C", "B", "C", "A", "B",
                      "C", "C", "A", "C", "A",
                      "B", "B", "D", "A", "B",
                      "B", "D", "D", "B", "D"
), nrow = 5, ncol = 5, byrow=TRUE))

ponto <- c("p1", "p2", "p3", "p4", "p5")
x <- c(1, 2, 3, 4, 5)
y <- c(0, 0, 0, 0, 0)
z <- y
P <- data.frame(ponto=ponto, x=x, y=y, z=z, stringsAsFactors = FALSE)

gamma <- 0.8
beta <- 2
sigma <- 1

gstsm_object <- gstsm(D, P, gamma, beta, sigma)

result <- mine(gstsm_object)

Documentation

Here all the functions are described.

gstsm

#' GSTSM
#'
#' S3 class definition for GSTSM.
#'
#' This algorithm is designed to the identification of frequent sequences in
#' STS datasets from the concept of Solid Ranged Groups (SRG).
#' GSTSM is based on the candidate-generating principle.
#' The goal is to start finding SRGs for sequences of size one.
#' Then it explores the support and the number of occurrences of SRGs for
#' larger sequences with a limited number of scans over the database.
#'
#' @param sts_dataset STS dataset
#' @param spatial_positions set of spatial positions
#' @param gamma minimum temporal frequency
#' @param beta minimum group size
#' @param sigma maximum distance between group points
#' @return a GSTSM object
#' @importFrom stats na.exclude
#' @export gstsm
gstsm <- function(sts_dataset, spatial_positions, gamma, beta, sigma)

find

#' S3 class definition for find method.
#'
#' @param object a GSTSM object
#' @param k size of sequence
#' @param ck set of candidates
#' @return Solid Ranged-Group(s) of all candidate sequences
#' @export find
find <- function(object, ck)

merge

#' S3 class definition for merge method.
#'
#' @param object a GSTSM object
#' @param ck set of candidates
#' @return Solid Ranged-Group(s) of all candidate sequences
#' @export merge
merge <- function(object, ck)

generate_candidates

#' S3 class definition for generate_candidates method.
#'
#' @param object a GSTSM object
#' @param srgk set of Solid Ranged Groups
#' @param k size of sequence
#' @return candidate sequences of size k + 1
#' @export generate_candidates
generate_candidates <- function(object, srgk)

mine

#' S3 class definition for mine method.
#'
#' @param object a GSTSM object
#' @return all Solid Ranged Group(s) found, of all sizes
#' @export mine
mine <- function(object)

Credits

This package was made with the following open source projects:

License

MIT


Antonio Castro • @castroantonio Cássio Souza • @cassiofb-dev Jorge Rodrigues • @jorge-g99 Esther Pacitti • Fabio Porto • Florent Masseglia • Rafaelli Coutinho • @rafaelliiicoutinho Eduardo Ogasawara • @eogasawara

Copy Link

Version

Install

install.packages('gstsm')

Monthly Downloads

142

Version

1.0.0

License

MIT + file LICENSE

Maintainer

Antonio Castro

Last Published

October 19th, 2022

Functions in gstsm (1.0.0)

mine

Mine - definition
merge.default

Merge - default
merge.gstsm

Merge - GSTSM implementation
validate_kernel_ranged_groups

Validate Kernel Ranged Groups
merge_open_kernel_ranged_groups

Merge Kernel Ranged Groups
mine.gstsm

Mine - GSTSM implementation
split_groups

Split Groups
generate_adjacency_matrix

Generate Adjacency Matrix
gstsm

GSTSM
generate_candidates.default

Generate Candidates - default
find_kernel_ranged_group

Find Kernel Ranged Group
find.gstsm

Find - GSTSM implementation
generate_candidates.gstsm

Generate Candidates - GSTSM implementation
find.default

Find - default
merge

Merge - definition
find

Find - definition
generate_candidates

Generate Candidates - definition
mine.default

Mine - default
merge_kernel_ranged_groups

Merge Kernel Ranged Groups
validate_and_close

Validate and Close