fix(r): CRAN warnings and comments (#14)

* Using a person's email Id for Maintainer role.
* Incremented the patch version.
* Improved description and added executable examples.

Author: spasumarthi21

r/factset.protobuf.stach/.Rbuildignore

@@ -1 +1,2 @@
-Makefile
+^Makefile$
+^cran-comments\.md$

r/factset.protobuf.stach/DESCRIPTION

@@ -1,10 +1,14 @@
 Package: factset.protobuf.stach
 Type: Package
-Title: FactSet's STACH Library
-Version: 1.0.1
+Title: 'FactSet' 'STACH' Library
+Version: 1.0.2
 Author: analytics-reporting
-Maintainer: Analytics API Support <analytics.api.support@factset.com>
-Description: Generates RProtobuf classes for FactSet's STACH tabular format.
+Maintainer: Charlie Mathis<chmathis@factset.com>
+Description: Generates 'RProtobuf' classes for 'FactSet' 'STACH' tabular 
+    format which represents complex multi-dimensional array of data. These 
+    classes help in the 'serialization' and 'deserialization' of 'STACH' 
+    formatted data. See 'GitHub' repository documentation for more 
+    information.
 URL: https://github.com/factset/stachschema
 BugReports: https://github.com/factset/stachschema/issues
 License: Apache License 2.0

r/factset.protobuf.stach/R/NullValues.R

@@ -9,6 +9,21 @@
 #' @field STRING Null value for STRING data type
 #' @field TIMESTAMP Null value for TIMESTAMP data type
 #' @field DURATION Null value for DURATION data type
+#' @examples
+#' nullValues <- factset.protobuf.stach.NullValues$new()
+#'
+#' # Null value comparison for Protobuf's String data type.
+#' a <- 'null'
+#' if(nullValues$STRING == a) print("a is the null") else print("a is not a null")
+#'
+#' # Null value comparison for Protobuf's Int32 data type.
+#' b <- new(google.protobuf.Int32Value, value = 2147483647)
+#' if(nullValues$INT32 == b$value) print("b is the null") else print("b is not a null")
+#'
+#' # Null value comparison for Protobuf's Duration data type.
+#' c <- new(google.protobuf.Duration, seconds = 315576000000, nanos = 999999900)
+#' if(nullValues$DURATION == c) print("c is the null") else print("c is not a null")
+#' @importFrom R6 R6Class
 #' @export
 factset.protobuf.stach.NullValues <- R6::R6Class(
   'factset.protobuf.stach.NullValues',

r/factset.protobuf.stach/cran-comments.md

@@ -0,0 +1,17 @@
+## Resubmission
+
+This is a resubmission. Following things were fixed as per the previous feedback.
+
+* Used a single person's email Id for the package maintainer field.
+* Improved the package description.
+* Used single quotes for package, software and API names in the title and description fields.
+* Added examples in the .Rd files.
+
+## Test environments
+* local Windows install - R 3.5.1
+* win-builder (devel and release)
+
+## R CMD check results
+There were no ERRORs or WARNINGS
+
+There was 1 NOTE: New submission.