Skip to content
This repository was archived by the owner on Aug 15, 2023. It is now read-only.

Api v2 #13

Open
goegges1 wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Api v2 #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8f3e889
Add aggregated frequency wrapper
goegges1 Jul 14, 2020
ec99962
Add split grouping to aggregate frequency call
goegges1 Jul 14, 2020
df57dbf
Update comment
goegges1 Jul 14, 2020
91e5859
add naming response columns
goegges1 Jul 20, 2020
181db84
add seperated functions
goegges1 Jul 21, 2020
b50e370
add sorting
goegges1 Aug 10, 2020
4a72833
add aggregate utility file
goegges1 Aug 10, 2020
5ec084c
change naming
goegges1 Sep 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 253 additions & 0 deletions R/aggregateFrequencies.R
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
#' freqRequestDataBuilder
#'
#' @param groupingType
#' @param dateType
#' @param attribute
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param miningRequestData
#'
#' @return
#' @export
#'
#' @examples
freqRequestDataBuilder <- function(groupingType, dateType, attribute, valuesFrom, maxAmountAttributes, valueSorting, sortingOrder, miningRequestData){
requestData <- list(
metric = metricFreqBuilder(),
valuesFrom = list(
type = valuesFrom
),
options = optionsBuilder(maxAmountAttributes, valueSorting, sortingOrder),
miningRequest = miningRequestData
)
if (groupingType != "null") {
requestData[["grouping"]] <- groupingBuilder(groupingType, dateType, attribute)
}
return(requestData)
}

#' aggregated frequencies API call
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param attribute
#' @param valuesFrom
#' @param groupingType
#' @param maxAmountAttributes
#' @param traceFilterSequence
#'
#' @return
#' @export
#'
#' @examples
freqContentBuilder <- function(lanaUrl, lanaToken, logId, dateType, attribute, valuesFrom,
groupingType, maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence){

miningRequestData <- miningRequestBuilder(logId, traceFilterSequence)
requestData <- freqRequestDataBuilder(groupingType, dateType, attribute, valuesFrom, maxAmountAttributes, valueSorting, sortingOrder, miningRequestData)
content <- aggregateApiCall(lanaUrl, requestData, lanaToken)
return(content)
}

#' aggregated frequencies without grouping
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#'
#' @return
#' @export
#'
#' @examples
getFreq <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, dateType = "null",
valuesFrom = "allCases", maxAmountAttributes = 10, valueSorting = "CaseCount",
sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "null"
freq <- freqContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute = NULL, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freq)

}

#' aggregated frequencies per year
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#'
#' @return
#' @export
#'
#' @examples
getFreqYear <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, dateType = "startDate",
valuesFrom = "allCases", maxAmountAttributes = 10, valueSorting = "CaseCount",
sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "byYear"
freqYear <- freqContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute = NULL, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freqYear)

}

#' aggregated frequencies per quarter
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#'
#' @return
#' @export
#'
#' @examples
getFreqQuarter <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, dateType = "startDate",
valuesFrom = "allCases", maxAmountAttributes = 10, valueSorting = "CaseCount",
sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "byQuarter"
freqQuarter <- freqContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute = NULL, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freqQuarter)

}

#' aggregated frequencies per month
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#'
#' @return
#' @export
#'
#' @examples
getFreqMonth <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, dateType = "startDate",
valuesFrom = "allCases", maxAmountAttributes = 10, valueSorting = "CaseCount",
sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "byMonth"
freqMonth <- freqContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute = NULL, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freqMonth)

}

#' aggregated frequencies per day of year
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#'
#' @return
#' @export
#'
#' @examples
getFreqDayofYear <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, dateType = "startDate",
valuesFrom = "allCases", maxAmountAttributes = 10, valueSorting = "CaseCount",
sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "byDayOfYear"
freqDayofYear <- freqContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute = NULL, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freqDayofYear)

}

#' aggregated frequencies per day of week
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#'
#' @return
#' @export
#'
#' @examples
getFreqDayofWeek <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, dateType = "startDate",
valuesFrom = "allCases", maxAmountAttributes = 10, valueSorting = "CaseCount",
sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "byDayOfWeek"
freqDayofWeek <- freqContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute = NULL, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freqDayofWeek)

}

#' aggregated frequencies per hour of day
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#'
#' @return
#' @export
#'
#' @examples
getFreqHourofDay <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, dateType = "startDate",
valuesFrom = "allCases", maxAmountAttributes = 10, valueSorting = "CaseCount",
sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "byHourOfDay"
freqHourofDay <- freqContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute = NULL, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freqHourofDay)

}

#' aggregated frequencies per attribute
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param attribute
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#'
#' @return
#' @export
#'
#' @examples
getFreqAttribute <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, attribute,
valuesFrom = "allCases", maxAmountAttributes = 10, valueSorting = "CaseCount",
sortingOrder = "Descending", traceFilterSequence = list()){
groupingType <- "byAttribute"
freqAttribute <- freqContentBuilder(lanaUrl, lanaToken, logId, dateType = NULL, attribute, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)

return(freqAttribute)
}


124 changes: 124 additions & 0 deletions R/aggregateNumeric.R
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
#' numRequestDataBuilder
#'
#' @param groupingType
#' @param dateType
#' @param attribute
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param miningRequestData
#'
#' @return
#' @export
#'
#' @examples
numRequestDataBuilder <- function(groupingType, dateType, attribute, agg, valuesFrom, maxAmountAttributes, valueSorting, sortingOrder, miningRequestData){
requestData <- list(
metric = metricNumBuilder(attribute, agg),
valuesFrom = list(
type = valuesFrom
),
options = optionsBuilder(maxAmountAttributes, valueSorting, sortingOrder),
miningRequest = miningRequestData
)
if (groupingType != "null") {
requestData[["grouping"]] <- groupingBuilder(groupingType, dateType, attribute)
}
return(requestData)
}

numContentBuilder <- function(lanaUrl, lanaToken, logId, dateType, attribute, agg, valuesFrom,
groupingType, maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence){

miningRequestData <- miningRequestBuilder(logId = logId, traceFilterSequence = traceFilterSequence)
requestData <- numRequestDataBuilder(groupingType, dateType, attribute, agg, valuesFrom, maxAmountAttributes,
valueSorting, sortingOrder, miningRequestData)
content <- aggregateApiCall(lanaUrl, requestData, lanaToken)
return(content)
}

#' aggregated numeric attribute per year
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#' @param attribute
#' @param agg
#' @param valueSorting
#' @param sortingOrder
#'
#' @return
#' @export
#'
#' @examples
getNumericYear <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, attribute, agg,
dateType = "startDate", valuesFrom = "allCases", maxAmountAttributes = 10,
valueSorting = "CaseCount", sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "byYear"
freqNumericYear <- numContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute, agg, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freqNumericYear)

}

#' aggregated numeric attribute per quarter
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#' @param attribute
#' @param agg mean, median, sum, min, max
#' @param valueSorting
#' @param sortingOrder
#'
#' @return
#' @export
#'
#' @examples
getNumericQuarter <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, attribute, agg,
dateType = "startDate", valuesFrom = "allCases", maxAmountAttributes = 10,
valueSorting = "CaseCount", sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "byQuarter"
freqNumericQuarter <- numContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute, agg, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freqNumericQuarter)

}

#' aggregated numeric attribute per quarter
#'
#' @param lanaUrl
#' @param lanaToken
#' @param logId
#' @param dateType
#' @param valuesFrom
#' @param maxAmountAttributes
#' @param traceFilterSequence
#' @param attribute
#' @param agg mean, median, sum, min, max
#' @param valueSorting
#' @param sortingOrder
#'
#' @return
#' @export
#'
#' @examples
getNumericQuarter <- function(lanaUrl = "cloud-backend.lanalabs.com", lanaToken, logId, attribute, agg,
dateType = "startDate", valuesFrom = "allCases", maxAmountAttributes = 10,
valueSorting = "CaseCount", sortingOrder = "Descending", traceFilterSequence = list()){

groupingType <- "byQuarter"
freqNumericQuarter <- numContentBuilder(lanaUrl, lanaToken, logId, dateType, attribute, agg, valuesFrom, groupingType,
maxAmountAttributes, valueSorting, sortingOrder, traceFilterSequence)
return(freqNumericQuarter)

}
Loading