wtsps is an R Client package for handling Web Time Series Processing Service (WTSPS) in the client side.
Clone the project: git clone https://github.com/e-sensing/wtsps.git.
Open Rstudio, go to File - Open Project and pick the file wtsps.Rproj.
Install the required package install.packages("roxygen2").
Go to the Build tab in the upper-right panel and press the button Build & Reload.
Installing and loading wtsps package
devtools::install_github("e-sensing/wtsps") # github repository name is wtsps
library(wtsps) # R package name is wtsps
A simple example of creating a WTSPS connection
wtsps.server <- WTSPS(serverURL = "inst/extdata/wtsps/")
The result is an Object of Class WTSPS.
wtsps.server
Object of Class WTSPS
The WTSPS server URL is: inst/extdata/wtsps/
The available algorithms are: TWDTW
It is possible to get the list of algorithms provided by a WTSPS service using a WTSPS object or simply a WTSPS server URL.
listAlgorithms(serverInfo = "inst/extdata/wtsps/")
## [1] "TWDTW"
We are also able to acquire any algorithm metadata with describeAlgorithm. This function returns an Algorithm class containing its name, input_parameters, output and a description using a WTSPS object already created or directly a WTSPS server URL.
describeAlgorithm(serverInfo = wtsps.server, name = "TWDTW")
Object of Class Algorithm:
The Algorithm name is: TWDTW
input parameters:
patterns = twdtwTimeSeries
dist.method = character
alpha = double
beta = double
theta = double
interval = character
span = integer
keep = boolean
overlap = double
start_date = character
end_date = character
output:
from = integer
to = integer
label = integer
distance = double
description: Time-Weighted Dynamic Time Warping (TWDTW) method for land use and land cover mapping using satellite image time series.
Using input_parameters we can run any process with that algorithm as many parameters as possible.
run_process <- runProcess(serverInfo = "inst/extdata/wtsps/", name = "TWDTW", patterns = "X")
run_process
Object of Class Process:
The Process uuid is: 1
Current status: Scheduled
Command (parameter = value) to enter in the server:
name = TWDTW
patterns = X
After that, WTSPS generates an identifier for this process so the user can see its status if necessary.
status.proc <- statusProcess(serverInfo = "inst/extdata/wtsps/", processInfo = 1)
status.proc
Object of Class Process:
The Process uuid is: 1
Current status: In Progress
Command (parameter = value) to enter in the server:
name = TWDTW
patterns = X
Or even cancel the process.
cancel.proc <- cancelProcess(serverInfo = "inst/extdata/wtsps/", processInfo = 1)
cancel.proc
Object of Class Process:
The Process uuid is: 1
Current status: Cancelled
Command (parameter = value) to enter in the server:
name = TWDTW
patterns = X
Any problem should be reported to esensing-developers@dpi.inpe.br.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.