Skip to content

Commit

Permalink
CRAN resubmission fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
donal committed Aug 11, 2018
1 parent 71dd5df commit 22960eb
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 8 deletions.
11 changes: 5 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
Package: brandwatchR
Type: Package
Title: Brandwatch API to R
Version: 0.1.0
Author: c(person("Donal", "Phipps", "[email protected]", role = c("aut", "cre")))
Title: 'Brandwatch' API to R
Version: 0.3.0
Authors@R: c(person("Donal", "Phipps", email = "[email protected]", role = c("aut", "cre")))
URL: https://github.com/Phippsy/brandwatchR
BugReports: https://github.com/Phippsy/brandwatchR
Maintainer: The package maintainer <[email protected]>
Description: Interact with the Brandwatch API <https://developers.brandwatch.com/docs>.
BugReports: https://github.com/Phippsy/brandwatchR/issues
Description: Interact with the 'Brandwatch' API <https://developers.brandwatch.com/docs>.
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
Expand Down
2 changes: 1 addition & 1 deletion R/categories.R
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
19 changes: 19 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion man/bwr_cat_get.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 22960eb

Please sign in to comment.