diff --git a/DESCRIPTION b/DESCRIPTION index 68269fb..94f833d 100644 --- a/DESCRIPTION +++ b/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 = "lukas@kappa-mm.de", role = c("cre","aut")), - person("Azadeh", "Khaleghi", email = "a.khaleghi@lancaster.ac.uk", 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 = "lukas@kappa-mm.de"), + person(given = "Azadeh", + family = "Khaleghi", + role = "aut", + email = "a.khaleghi@lancaster.ac.uk")) Maintainer: Lukas Zierahn -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) and A. + Khaleghi, D. Ryabko (2012) + . +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 diff --git a/NEWS.md b/NEWS.md index b7121b0..59f606e 100644 --- a/NEWS.md +++ b/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. diff --git a/R/install_PyChest.R b/R/install_PyChest.R index 723afd2..12220b7 100644 --- a/R/install_PyChest.R +++ b/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") diff --git a/R/list_estimator.R b/R/list_estimator.R index 16ba888..164d511 100644 --- a/R/list_estimator.R +++ b/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) { diff --git a/cran-comments.md b/cran-comments.md index 116f745..25368d6 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -10,11 +10,20 @@ For a CRAN submission we recommend that you fix all NOTEs, WARNINGs and ERRORs. Maintainer: 'Lukas Zierahn ' 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. \ No newline at end of file diff --git a/man/install_PyChest.Rd b/man/install_PyChest.Rd index aa3dd99..f224cd1 100644 --- a/man/install_PyChest.Rd +++ b/man/install_PyChest.Rd @@ -6,6 +6,9 @@ \usage{ install_PyChest() } +\value{ +No return value, called to install the PyChest Package +} \description{ Initializes the package and installs/updates PyChest into the local reticulate-Python environment } diff --git a/man/list_estimator.Rd b/man/list_estimator.Rd index 3272e45..4d3fe4e 100644 --- a/man/list_estimator.Rd +++ b/man/list_estimator.Rd @@ -12,7 +12,7 @@ list_estimator(sample, minimum_distance) \item{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)} } \value{ -The list of changepoints in order of likelihood +The list of changepoints in order of score } \description{ Returns the position of changepoints in the sequence