Prepare the 0.6.0 release (#105)

Author: erikcs

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to `maq` will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.0] - 2025-04-14
+
+## Added
+- Add convenience function `scale_maq` for mapping policy values and budgets to a specific application. [#104](https://github.com/grf-labs/maq/pull/104)
+
 ## [0.5.0] - 2024-11-14
 
 ### Added

RELEASES.md

@@ -87,6 +87,10 @@ For a big release, can also run `R CMD check --as-cran --run-donttest --use-valg
 
 ## Previous performance test results
 
+**0.6.0**
+
+Only a minor release with no perf/C++ touches.
+
 **0.5.0**
 
 Only a minor release with no perf/C++ touches.

r-package/maq/DESCRIPTION

@@ -1,6 +1,6 @@
 Package: maq
 Title: Multi-Armed Qini
-Version: 0.5.0
+Version: 0.6.0
 Authors@R: c(
     person("Erik", "Sverdrup", email = "[email protected]", role = c("aut", "cre")),
     person("Han", "Wu", role = "aut"),

r-package/maq/NAMESPACE

@@ -10,7 +10,7 @@ export(get_aipw_scores)
 export(get_ipw_scores)
 export(integrated_difference)
 export(maq)
-export(maq_scale)
+export(scale_maq)
 importFrom(Rcpp,evalCpp)
 importFrom(stats,predict)
 useDynLib(maq, .registration = TRUE)

r-package/maq/R/maq.R

@@ -551,13 +551,13 @@ integrated_difference <- function(object.lhs,
 
 #' Scale a Qini curve.
 #'
-#' Remap the policy value and budget to some problem-specific application.
-#' This is a convenience function that is usually useful for plotting.
+#' Remaps the policy value and budget to application-specific units.
+#' This convenience function is typically useful for plots.
 #'
 #' @param object A maq object.
 #' @param scale A numeric value to scale by.
 #'
-#' @return A rescaled maq object.
+#' @return A maq object with policy values and budget rescaled by the given factor.
 #'
 #' @examples
 #' \donttest{
@@ -572,15 +572,17 @@ integrated_difference <- function(object.lhs,
 #' qini <- maq(reward, cost, scores, R = 200)
 #'
 #' # Plot the policy values as we vary the fraction treated.
-#' qini |>
-#'   plot(xlab = "Treated fraction")
+#' plot(qini, xlab = "Fraction treated")
 #'
 #' # Plot the policy values for a maximum allocation of, for example, 500 units.
-#' maq_scale(qini, 500) |>
-#'   plot(xlab = "Units treated")
+#' plot(scale_maq(qini, 500), xlab = "Units treated")
+#'
+#' # With R 4.1.0 or later, the native pipe can be used to chain scaling and plotting.
+#' # scale_maq(qini, 500) |>
+#' #   plot(xlab = "Units treated")
 #'}
 #' @export
-maq_scale <- function(object,
+scale_maq <- function(object,
                       scale = 1) {
   object[["_path"]]$spend <- scale * object[["_path"]]$spend
   object[["_path"]]$gain <- scale * object[["_path"]]$gain

r-package/maq/man/maq_scale.Rd renamed to r-package/maq/man/scale_maq.Rd

@@ -16,11 +16,11 @@ reference:
   - title: Multi-Armed Qini
     contents:
       - maq
-      - maq_scale
       - predict.maq
       - average_gain
       - difference_gain
       - integrated_difference
+      - scale_maq
       - get_ipw_scores
       - get_aipw_scores
 

r-package/maq/pkgdown/_pkgdown.yml

@@ -559,7 +559,7 @@ test_that("integrated_difference grid lookup numerics works as expected", {
   expect_equal(est, estt, tolerance = 1e-10)
 })
 
-test_that("maq_scale works as expected", {
+test_that("scale_maq works as expected", {
   n <- 500
   K <- 2
   reward <- matrix(1 + rnorm(n * K), n, K)
@@ -570,7 +570,7 @@ test_that("maq_scale works as expected", {
   qini <- maq(reward, cost, scores, R = 200)
   qini.s <- maq(reward, cost * scale, scores * scale, R = 200)
 
-  expect_equal(qini.s, maq_scale(qini, scale))
+  expect_equal(qini.s, scale_maq(qini, scale))
   expect_equal(average_gain(qini.s, 42),
-               average_gain(maq_scale(qini, scale), 42))
+               average_gain(scale_maq(qini, scale), 42))
 })