Changed the package according to the feedback of our first CRAN submi…

…ssion, This is now RChest v1.0.2

DESCRIPTION

@@ -1,18 +1,32 @@
-Package: RChest
 Type: Package
-Title: Locating Distributional Changes in Piece-Wise Stationary Time-Series with Long-Range Dependencies
-Version: 1.0.1
-Authors@R: c(
-    person("Lukas", "Zierahn", email = "[email protected]", role = c("cre","aut")),
-    person("Azadeh", "Khaleghi", email = "[email protected]", role = "aut"))
+Package: RChest
+Title: Locating Distributional Changes in Highly Dependent Time
+    Series
+Version: 1.0.2
+Authors@R: 
+    c(person(given = "Lukas",
+             family = "Zierahn",
+             role = c("cre", "aut"),
+             email = "[email protected]"),
+      person(given = "Azadeh",
+             family = "Khaleghi",
+             role = "aut",
+             email = "[email protected]"))
 Maintainer: Lukas Zierahn <[email protected]>
-Description: Locating distributional changes in piece-wise stationary time-series with long-range dependencies. We are using an implementation in Go with a strong focus on parallel computation.
+Description: We are using an implementation in Go with a strong
+    focus on parallel computation in order to locate distributional
+    changes in piece-wise stationary time-series with long-range
+    dependencies like suggested by the papers A. Khaleghi, D. Ryabko
+    (2014) <http://proceedings.mlr.press/v32/khaleghi14.html> and A.
+    Khaleghi, D. Ryabko (2012)
+    <https://proceedings.neurips.cc/paper/2012/file/299fb2142d7de959380f91c01c3a293c-Paper.pdf>.
+License: MIT + file LICENSE
 URL: https://github.com/azalk/GoChest
 BugReports: https://github.com/azalk/GoChest/issues
-License: MIT + file LICENSE
+Imports: 
+    reticulate
+Suggests: 
+    testthat
 Encoding: UTF-8
 LazyData: true
-Imports: reticulate
 RoxygenNote: 7.1.1
-Suggests: 
-    testthat

NEWS.md

@@ -1,3 +1,10 @@
+# RChest 1.0.2
+
+* Changed the title to fit the 65 Character limit
+* Changed the Description field in the DESCRIPTION file to not start with the title anymore
+* Added citations in the Description field in the DESCRIPTION file
+* Added description of the return value for the install_Pychest() function in the documentation
+
 # RChest 1.0.1
 
 * Added a `NEWS.md` file to track changes to the package.

R/install_PyChest.R

@@ -2,6 +2,8 @@
 #'
 #' Initializes the package and installs/updates PyChest into the local reticulate-Python environment
 #'
+#' @return No return value, called to install the PyChest Package
+#'
 #' @export
 install_PyChest <- function() {
   reticulate::py_install("cython")

R/list_estimator.R

@@ -5,7 +5,7 @@
 #' @param sample A vector of floats corresponding to the piecewise stationary sample where the retrospective changes are to be sought
 #' @param minimum_distance A real number between 0 and 1 corresponding to a lower-bound on the minimum normalized length of the stationary segments (as percentage of total sample length)
 #'
-#' @return The list of changepoints in order of likelihood
+#' @return The list of changepoints in order of score
 #'
 #' @export
 list_estimator <- function(sample, minimum_distance) {

cran-comments.md

@@ -10,11 +10,20 @@ For a CRAN submission we recommend that you fix all NOTEs, WARNINGs and ERRORs.
   Maintainer: 'Lukas Zierahn <[email protected]>'
 
   New submission
+
+    Khaleghi (10:8, 10:93)
+  Possibly mis-spelled words in DESCRIPTION:
+    Ryabko (10:21, 10:106)
 
 0 errors ✔ | 0 warnings ✔ | 1 note ✖
 
 
 ## Authors comments
 
-* The test coverage of this package is quite small at about 40% which is due to the nature of the package also being quite small
+### Comments for Version 1.0.2 (Current Version)
+* We amended this version following our first submission and hope to have fixed all errors, see the NEWS file for all changes.
+* The possibly mis-spelled words in DESCRIPTION are the names of the authors of the packages we are citing.
+
+### Comments for Version 1.0.1
+* The test coverage of this package is quite small at about 40% which is due to the nature of the package also being quite small.
 * Additionally the unit-tests have been skipped on the rhub servers as they require the Python Package "PyChest" to be installed on the reticulate environment of the server testing the package. You can run "RChest::install_PyChest()" to install "PyChest" into the environment, the tests should then Pass.