Ready for CRAN

marberts · Nov 18, 2023 · 2025d4f · 2025d4f
1 parent 637a9a0
commit 2025d4f
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 12 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: piar
 Title: Price Index Aggregation
-Version: 0.5.0.9030
+Version: 0.6.0
 Authors@R: c(
     person("Steve", "Martin", role = c("aut", "cre", "cph"),
            email = "[email protected]",

diff --git a/R/aggregation_structure-class.R b/R/aggregation_structure-class.R
@@ -88,7 +88,7 @@ str.piar_aggregation_structure <- function(object, ...) {
 
 #' Test if an object is a price index aggregation structure
 #'
-#' Test if an object is a price index aggregation structure
+#' Test if an object is a price index aggregation structure.
 #'
 #' @param x An object to test.
 #'

diff --git a/R/aggregation_structure.R b/R/aggregation_structure.R
@@ -16,8 +16,8 @@
 #' elemental aggregate the same weight.
 #'
 #' @returns
-#' A price index aggregation structure. This is an object of class
-#' `piar_aggregation_structure`, which has the following components.
+#' A price index aggregation structure of class `piar_aggregation_structure`.
+#' This is a list-S3 class with the following components.
 #'
 #' \item{child}{A nested list that gives the positions of the immediate
 #' children for each node in each level of the aggregation structure above the

diff --git a/R/expand_classification.R b/R/expand_classification.R
@@ -52,7 +52,7 @@ paste_until <- function(x, i) {
 expand_classification <- function(x, width = 1L) {
   x <- as.character(x)
   width <- as.integer(width)
-  if (any(width <= 0)) {
+  if (any(width <= 0L)) {
     stop("'width' must be strictly positive")
   }
   if (anyNA(width)) {

diff --git a/R/mean.piar_index.R b/R/mean.piar_index.R
@@ -54,7 +54,7 @@
 #'
 #' @family index methods
 #' @export
-mean.piar_index <- function(x, weights = NULL, window = 3, na.rm = FALSE,
+mean.piar_index <- function(x, weights = NULL, window = 3L, na.rm = FALSE,
                             r = 1, ...) {
   if (!is.null(weights)) {
     if (length(weights) != length(x$time) * length(x$levels)) {

diff --git a/README.Rmd b/README.Rmd
@@ -12,7 +12,7 @@ knitr::opts_chunk$set(
 )
 ```
 
-# Price Index Aggregation in R <a href="https://marberts/github.io/piar/"><img src="man/figures/logo.png" align="right" height="139" alt="piar website" /></a>
+# Price Index Aggregation in R <a href="https://marberts.github.io/piar/"><img src="man/figures/logo.png" align="right" height="139" alt="piar website" /></a>
 
 <!-- badges: start -->
 [![CRAN status](https://www.r-pkg.org/badges/version/piar)](https://cran.r-project.org/package=piar)

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file. -->
 
-# Price Index Aggregation in R <a href="https://marberts/github.io/piar/"><img src="man/figures/logo.png" align="right" height="139" alt="piar website" /></a>
+# Price Index Aggregation in R <a href="https://marberts.github.io/piar/"><img src="man/figures/logo.png" align="right" height="139" alt="piar website" /></a>
 
 <!-- badges: start -->
 

diff --git a/man/aggregation_structure.Rd b/man/aggregation_structure.Rd
diff --git a/man/is_aggregation_structure.Rd b/man/is_aggregation_structure.Rd
diff --git a/man/mean.piar_index.Rd b/man/mean.piar_index.Rd