docs: CRAN comments

CRAN-RELEASE

@@ -1,2 +1,2 @@
-This package was submitted to CRAN on 2021-11-10.
-Once it is accepted, delete this file and tag the release (commit 6b6b8d8).
+This package was submitted to CRAN on 2021-11-11.
+Once it is accepted, delete this file and tag the release (commit eec09a1).

DESCRIPTION

@@ -1,13 +1,13 @@
 Package: googlePubsubR
-Title: R Interface for Google Cloud Pub/Sub REST API
+Title: R Interface for Google 'Cloud Pub/Sub' REST API
 Version: 0.0.1
 Authors@R: 
     person(given = "Andrea",
            family = "Dodet",
            role = c("aut", "cre"),
            email = "[email protected]")
-Description: Provides an easy to use interface to the Google
-	Pub/Sub REST API.
+Description: Provides an easy to use interface to the 'Google
+	Pub/Sub' REST API <https://cloud.google.com/pubsub/docs/reference/rest>.
 URL: https://github.com/andodet/googlePubsubR
 BugReports: https://github.com/andodet/googlePubsubR/issues
 License: MIT + file LICENSE

LICENSE

@@ -1,16 +1,2 @@
-Copyright 2021 Andrea Dodet
-
-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.
+YEAR: 2021
+COPYRIGHT HOLDER: Andrea Dodet

R/auth.R

@@ -6,6 +6,8 @@
 #'   account
 #' @param token `character` An existing authentication token
 #' @param email `character` The email to default authentication to
+#' 
+#' @return None, called for side effects
 #'
 #' @import googleAuthR
 #' @export

R/schemas.R

@@ -66,6 +66,8 @@ schemas_create <- function(name,
 #'
 #' @param schema `Schema` Required, an instance of a `Schema` object
 #' @param project `character` GCP project id
+#' 
+#' @return `logical` TRUE if successfully validated
 #'
 #' @importFrom googleAuthR gar_api_generator
 #' @family Schema functions
@@ -163,6 +165,8 @@ schemas_get <- function(schema,
 #' Deletes a schema
 #'
 #' @param name `character`, `Schema` Schema name or instance of a schema object
+#' 
+#' @return None, called for side effects
 #'
 #' @importFrom googleAuthR gar_api_generator
 #' @family Schema functions

R/snapshots.R

@@ -69,6 +69,8 @@ snapshots_create <- function(name, subscription, labels = NULL) {
 #'
 #' @param snapshot `Snapshot`, `character` Required, an instance of a `Snapshot` object or a
 #'   object or a subscription name
+#'   
+#' @return None, called for side effects
 #'
 #' @importFrom googleAuthR gar_api_generator
 #' @family Snapshot functions

R/subscriptions.R

@@ -114,6 +114,8 @@ subscriptions_create <- function(name,
 #'
 #' @param subscription `character`, `Subscription` Required, subscription name or instance of
 #'   a `Subscription` object
+#'   
+#' @return None, called for side effects
 #'
 #' @importFrom googleAuthR gar_api_generator
 #' @family Subscription functions
@@ -152,6 +154,8 @@ subscriptions_get <- function(subscription) {
 #'
 #' @param subscription `character`, `Subscription` Required, subscription name or instance of
 #'   a `Subscription` object
+#'   
+#' @return `logical`, TRUE if successfully detached
 #'
 #' @importFrom googleAuthR gar_api_generator
 #' @family Subscription functions
@@ -399,7 +403,7 @@ subscriptions_modify_ack_deadline <- function(subscription, ack_ids, ack_deadlin
 #'   object
 #' @param push_config `PushConfig` New PushConfig object, can be built using \code{\link{PushConfig}}
 #'
-#' @return `logical`
+#' @return `logical`, TRUE if successfully modified
 #' @family Subscription functions
 #' @export
 subscriptions_modify_pushconf <- function(subscription, push_config) {

R/topics.R

@@ -85,6 +85,9 @@ topics_create <- function(name,
 #' Deletes a pub/sub topic
 #'
 #' @param topic `character`, `Topic` Required, topic name or instance of a `Topic` object
+#' 
+#' @return None, called for side effects
+#' 
 #' @importFrom googleAuthR gar_api_generator
 #' @family Topic functions
 #' @export
@@ -100,7 +103,7 @@ topics_delete <- function(topic) {
 #' Gets a topic configuration
 #'
 #' @param topic `character`, `Topic` Required, topic name or instance of a `Topic`
-#' @return `Topic` A `Topic` object
+#' @return `Topic`, A `Topic` object
 #'
 #' @importFrom googleAuthR gar_api_generator
 #' @family Topic functions
@@ -125,7 +128,7 @@ topics_get <- function(topic) {
 #'  that this is a continuation of a prior `ListTopics` call, and that the system should return the
 #'  next page of data.
 #'
-#' @return A `list`
+#' @return A `list` of topics
 #'
 #' @importFrom googleAuthR gar_api_generator
 #' @family Topic functions
@@ -148,7 +151,7 @@ topics_list <- function(project = Sys.getenv("GCP_PROJECT"), pageSize = NULL,
 #' @param topic `character`, `Topic` Required, topic name or instance of a topic object
 #' @param project `character` GCP project id
 #'
-#' @return `logical`
+#' @return `logical`, TRUE if topic exists, FALSE otherwise
 #' @family Topic functions
 #' @export
 topics_exists <- function(topic, project = Sys.getenv("GCP_PROJECT")) {

README.md

@@ -2,7 +2,7 @@
 
 [![R-CMD-check-ascran](https://github.com/andodet/googlePubsubR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/andodet/googlePubsubR/actions/workflows/R-CMD-check.yaml)
 [![testthat](https://github.com/andodet/googlePubsubR/actions/workflows/testthat.yaml/badge.svg)](https://github.com/andodet/googlePubsubR/actions/workflows/testthat.yaml)
-[![codecov](https://codecov.io/gh/andodet/googlePubsubR/branch/master/graph/badge.svg?token=OTBHY3F1KD)](https://codecov.io/gh/andodet/googlePubsubR)
+[![codecov](https://codecov.io/gh/andodet/googlePubsubR/branch/master/graph/badge.svg?token=OTBHY3F1KD)](https://app.codecov.io/gh/andodet/googlePubsubR)
 
 This library offers an easy to use interface for the Google Pub/Sub REST API
 (docs [here](https://cloud.google.com/pubsub/docs/reference/rest)).
@@ -11,9 +11,12 @@ Not an official Google product.
 
 ## Setup
 
-You can install the package (not on CRAN for the time being) from Github:
+You can install the package from CRAN or get the `dev` version from Github:
 ```r
-devtools::install_github("andodet/googlePubsubR")
+install.packages("googlePubsubR")
+
+# Or get the dev version from Github
+devtools::install_github("andodet/googlePubsubR@dev")
 ```
 
 In order to use the library, you will need:

cran-comments.md

@@ -1,3 +1,19 @@
+## Resubmission
+
+This is a resubmission. In this version I have:
+
+* Added `\value` tags as requested to the following functions:
+  - `pubsub_auth.Rd`
+  - `pubsub_auth.Rd`
+  - `schemas_delete.Rd`
+  - `schemas_validate.Rd`
+  - `snapshots_delete.Rd`
+  - `subscriptions_delete.Rd`
+  - `subscriptions_detach.Rd`
+  - `topics_delete.Rd`
+
+* Enclosed 'Cloud Pub/Sub' in single quotes in title and description
+
 ## Test environments
 
 * Ubuntu 20.04 (on Github Actions), r-devel