diff --git a/DESCRIPTION b/DESCRIPTION index 89ba452..f722402 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,12 +1,11 @@ Package: brandwatchR Type: Package -Title: Brandwatch API to R -Version: 0.1.0 -Author: c(person("Donal", "Phipps", "donal.phipps@gmail.com", role = c("aut", "cre"))) +Title: 'Brandwatch' API to R +Version: 0.3.0 +Authors@R: c(person("Donal", "Phipps", email = "donal.phipps@gmail.com", role = c("aut", "cre"))) URL: https://github.com/Phippsy/brandwatchR -BugReports: https://github.com/Phippsy/brandwatchR -Maintainer: The package maintainer -Description: Interact with the Brandwatch API . +BugReports: https://github.com/Phippsy/brandwatchR/issues +Description: Interact with the 'Brandwatch' API . Allows you to authenticate to the API and obtain data for projects, queries, query groups tags and categories. Also allows you to directly obtain mentions and aggregate data for a specified query or query group. License: MIT + file LICENSE diff --git a/R/categories.R b/R/categories.R index 94a7245..e84da9f 100644 --- a/R/categories.R +++ b/R/categories.R @@ -15,7 +15,7 @@ #' @export #' #' @examples -#' \dontrun{my_categories <- bwr_cat_get(project_id = 12334534))} +#' \dontrun{my_categories <- bwr_cat_get(project_id = 12334534)} bwr_cat_get <- function(project_id = NULL, token = Sys.getenv("BW_TOKEN")) { if (length(token) != 1 || class(token) != "character") stop("Token object does not appear to be a character vector of length one. Please re-run bwr_auth() to obtain a token") diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 0000000..971c3ef --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,19 @@ +## Resubmission +This is a resubmission. In this version I have: + +* Added single quotations to usage of 'Brandwatch' in the package Title and Description. +* Updated the author description by using the person() function in the Authors@R field, in the DESCRIPTION field. +* Fixed unexecutable code in man/bwr_cat_get.Rd by removing the unnecessary closing bracket. +* Tested the package on Ubuntu as well as OSX and Windows. + +## Test environments +* local OS X install, R 3.5.1 +* windows 10, R 3.4.3 +* ubuntu 18.04.1, R 3.4.3 + +## R CMD check results +There were no ERRORs, WARNINGs or NOTEs. + +## Authentication +As Brandwatch is a paid platform, API calls cannot be tested without a valid username / password, which I have not been able to provide within this package due to security restrictions. +Should it be useful, please contact me by email and I'll be happy to share authentication to facilitate testing any functions. Thank you. diff --git a/man/bwr_cat_get.Rd b/man/bwr_cat_get.Rd index 969b9d4..8fe25a2 100644 --- a/man/bwr_cat_get.Rd +++ b/man/bwr_cat_get.Rd @@ -21,5 +21,5 @@ See the Brandwatch documentation for more information at https://developers.brandwatch.com/docs/retrieving-categories. } \examples{ -\dontrun{my_categories <- bwr_cat_get(project_id = 12334534))} +\dontrun{my_categories <- bwr_cat_get(project_id = 12334534)} }