# Copyright (c) 2018 BrandsEye
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#' Gets the 'authors metric' for a given filter
#'
#' @param code The account code to use
#' @param filter The filter for the data
#' @param file An optional file name to save a CSV file to
#' @param save Set to TRUE if you'd like a dialog to choose where to save your CSV
#' @param truncateAt Optional number of results - rest will become "Others"
#'
#' @return A tibble of your data
#' @export
#'
#' @examples
#'
#' authors_metric("QUIR01BA", "published inthelast week and brand isorchildof 10006")
authors_metric <- function(code, filter, file = NULL, save = FALSE, truncateAt = NULL) {
# For devtools::check
mentionCount <- NULL; . <- NULL; authorHandle <- NULL; authorId <- NULL; authorName <- NULL;
engagement <- NULL; totalEngagement <- NULL; totalOTS <- NULL; totalSentiment <- NULL;
netSentiment <- NULL;
ac <- account(code)
data <- count_mentions(ac, filter,
groupBy = c(authorId, authorHandle, authorName),
select = c(mentionCount, totalSentiment, totalOTS, engagement))
if (!is.null(truncateAt)) {
assert_that(is.number(truncateAt))
top <- data %>% top_n(n = truncateAt, wt=mentionCount)
others <- data %>%
top_n(n=-(nrow(.)-truncateAt), wt=mentionCount) %$%
tibble(authorId="Others", authorHandle="Others", authorName="Others",
mentionCount = sum(mentionCount, na.rm = TRUE),
totalSentiment = sum(totalSentiment, na.rm = TRUE),
totalOTS = sum(totalOTS, na.rm = TRUE),
totalEngagement = sum(totalEngagement, na.rm = TRUE))
data <- bind_rows(top, others)
}
data %<>%
rename(count = mentionCount,
netSentiment = totalSentiment,
ots = totalOTS,
engagement = totalEngagement) %>%
mutate(netSentimentPercent = ifelse(count == 0, 0, netSentiment / count)) %>%
select(authorId, authorHandle, authorName, count, everything())
if (save) file = rstudioapi::selectFile(caption = "Save as",
filter = "CSV Files (*.csv)",
existing = FALSE)
if (save && is.null(file)) {
warn("Saving of file cancelled")
}
if (!is.null(file)) {
data %>%
tidyr::replace_na(list(engagement = 0, ots = 0, sentiment = 0)) %>%
readr::write_excel_csv(file, na = "")
done(glue("Written your CSV to {file}"))
}
data
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.