Merge pull request CenterForAssessment#1469 from dbetebenner/master

Updating RLI meta-data including configurations

Author: dbetebenner

CITATION.cff

@@ -11,7 +11,7 @@ authors:
 - family-names: "Shang"
   given-names: "Yi"
 title: "SGP: Student Growth Percentiles & Percentile Growth Trajectories"
-version: 2.2-1.96
+version: 2.2-1.98
 doi: 10.5281/zenodo.13921157
-date-released: 2025-3-18
+date-released: 2025-4-14
 url: "https://sgp.io"

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: SGP
 Type: Package
 Title: Student Growth Percentiles & Percentile Growth Trajectories
-Version: 2.2-1.96
-Date: 2025-3-18
+Version: 2.2-1.98
+Date: 2025-4-14
 Authors@R: c(person(given=c("Damian", "W."), family="Betebenner", email="dbetebenner@nciea.org", role=c("aut", "cre"), comment=c(ORCID = "0000-0003-0476-5599")),
 		person(given=c("Adam", "R."), family="Van Iwaarden", email="avaniwaarden@nciea.org", role="aut"),
 		person(given="Ben", family="Domingue", email="ben.domingue@gmail.com", role="aut"),

R/outputSGP.R

@@ -825,11 +825,11 @@ function(sgp_object,
 					CONTENT_AREA=unlist(strsplit(names.iter, "[.]"))[1],
 					YEAR=getTableNameYear(names.iter),
 					sgp_object@SGP[["SGProjections"]][[names.iter]], key=c("VALID_CASE", "CONTENT_AREA", "YEAR", "ID"))
-				tmp.index <- tmp.table[,c("VALID_CASE", "CONTENT_AREA", "YEAR", "ID"), with=FALSE]
+				tmp.index <- tmp.table[,c("VALID_CASE", "CONTENT_AREA", "YEAR", "ID", "GRADE"), with=FALSE]
 
 				if (any(c("CATCH_UP_KEEP_UP_STATUS_INITIAL_CURRENT", "MOVE_UP_STAY_UP_STATUS_INITIAL_CURRENT") %in% names(slot.data))) {
 					sgp_object@SGP[["SGProjections"]][[names.iter]] <-
-						tmp.table[,intersect(names(slot.data), c("CATCH_UP_KEEP_UP_STATUS_INITIAL_CURRENT", "MOVE_UP_STAY_UP_STATUS_INITIAL_CURRENT")) := slot.data[tmp.index][,
+						tmp.table[,intersect(names(slot.data), c("CATCH_UP_KEEP_UP_STATUS_INITIAL_CURRENT", "MOVE_UP_STAY_UP_STATUS_INITIAL_CURRENT")) := slot.data[tmp.index, on=c("VALID_CASE", "CONTENT_AREA", "YEAR", "ID", "GRADE"),
 							intersect(names(slot.data), c("CATCH_UP_KEEP_UP_STATUS_INITIAL_CURRENT", "MOVE_UP_STAY_UP_STATUS_INITIAL_CURRENT")), with=FALSE]][,!c("VALID_CASE", "CONTENT_AREA", "YEAR"), with=FALSE]
 				}
 				output.column.order <- SGP::SGPstateData[['RLI']][['SGP_Configuration']][['output.column.order']][['SGProjection']]

R/rliSGP.R

@@ -17,6 +17,7 @@ function(sgp_object,
 	simulate.sgps=FALSE,
 	save.intermediate.results=FALSE,
 	coefficient.matrices=NULL,
+	coefficient.matrices.year=NULL,
 	goodness.of.fit.print=FALSE,
 	return.updated.shell=FALSE,
 	fix.duplicates="KEEP.ALL",
@@ -158,16 +159,20 @@ function(sgp_object,
 	if (length(find.package("RLImatrices", quiet=TRUE))==0) stop("Package RLImatrices required from GitHub.")
 	if (is.null(coefficient.matrices)) {
 		eval(parse(text="require(RLImatrices)"))
-		matrix.years <- getRLIMatrixYears(score.type)
-		tmp.configuration.year <- paste(configuration.year, match(testing.window, c("FALL", "WINTER", "SPRING")), sep=".")
-		tmp.data.last.year <- tail(sort(unique(additional.data[['YEAR']])), 1L)
-		if (!tmp.configuration.year %in% matrix.years) {
-			messageSGP(paste0("\tNOTE: ", tmp.configuration.year, " indicated in the configuration has no matrices in ", paste(state, "SGPt_Baseline_Matrices", sep="_")))
-			if (tmp.data.last.year > tail(matrix.years, 1L)) tmp.matrix.year <- tail(matrix.years, 1L)
-			if (tmp.data.last.year < head(matrix.years, 1L)) tmp.matrix.year <- head(matrix.years, 1L)
-			if (!exists("tmp.matrix.year")) tmp.matrix.year <- tmp.configuration.year
+		if (is.null(coefficient.matrices.year)) {
+			matrix.years <- getRLIMatrixYears(score.type)
+			tmp.configuration.year <- paste(configuration.year, match(testing.window, c("FALL", "WINTER", "SPRING")), sep=".")
+			tmp.data.last.year <- tail(sort(unique(additional.data[['YEAR']])), 1L)
+			if (!tmp.configuration.year %in% matrix.years) {
+				messageSGP(paste0("\tNOTE: ", tmp.configuration.year, " indicated in the configuration has no matrices in ", paste(state, "SGPt_Baseline_Matrices", sep="_")))
+				if (tmp.data.last.year > tail(matrix.years, 1L)) tmp.matrix.year <- tail(matrix.years, 1L)
+				if (tmp.data.last.year < head(matrix.years, 1L)) tmp.matrix.year <- head(matrix.years, 1L)
+				if (!exists("tmp.matrix.year")) tmp.matrix.year <- tmp.configuration.year
+			} else {
+				tmp.matrix.year <- tmp.configuration.year
+			}
 		} else {
-			tmp.matrix.year <- tmp.configuration.year
+			tmp.matrix.year <- coefficient.matrices.year
 		}
 		matrix.label <- paste0(paste(state, "SGPt_Baseline_Matrices", sep="_"), "$", paste(state, "SGPt_Baseline_Matrices", tmp.matrix.year, sep="_"))
 		messageSGP(paste0("\tNOTE: rliSGP using matrices ", paste(state, "SGPt_Baseline_Matrices", tmp.matrix.year, sep="_")))

R/zzz.R

@@ -35,7 +35,7 @@ function(libname, pkgname) {
 
         # Define a friendly startup message
 		message_text <- paste0(
-		    magenta(bold("\uD83C\uDF89 SGP v", installed.version, sep="")), " - ", toOrdinal::toOrdinalDate("2025-3-18"), "\n",
+		    magenta(bold("\uD83C\uDF89 SGP v", installed.version, sep="")), " - ", toOrdinal::toOrdinalDate("2025-4-14"), "\n",
 			strrep("\u2501", 40), "\n",
     	    bold("\U1F4E6 CRAN: "), cran.version, "\n",
     	    bold("\U1F527 Dev: "), dev.version, "\n",

README.md

@@ -5,7 +5,7 @@ SGP
 [![R-CMD-check](https://github.com/CenterForAssessment/SGP/workflows/R-CMD-check/badge.svg)](https://github.com/CenterForAssessment/SGP/actions)
 [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/centerforassessment/SGP?branch=master&svg=true)](https://ci.appveyor.com/project/centerforassessment/SGP)
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/SGP)](https://cran.r-project.org/package=SGP)
-[![Development Version](https://img.shields.io/badge/devel-2.2--1.96-brightgreen.svg)](https://github.com/CenterForAssessment/SGP)
+[![Development Version](https://img.shields.io/badge/devel-2.2--1.98-brightgreen.svg)](https://github.com/CenterForAssessment/SGP)
 [![Rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/grand-total/SGP)](https://github.com/metacran/cranlogs.app)
 [![License](https://img.shields.io/badge/license-GPL%203-brightgreen.svg?style=flat)](https://github.com/CenterForAssessment/SGP/blob/master/LICENSE.md)
 [![Join the chat at https://gitter.im/CenterForAssessment/SGP](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/CenterForAssessment/SGP?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

data/SGPstateData.rda

@@ -9,12 +9,12 @@ bibentry(
                     person(given = c("Yi"), family = "Shang")
                    ),
     year         = "2025",
-    note         = "R package version 2.2-1.96",
+    note         = "R package version 2.2-1.98",
     url          = "https://sgp.io",
     textVersion  = paste(
                     "Damian W. Betebenner, Adam R. Van Iwaarden, Benjamin Domingue and Yi Shang (2025).",
                     "SGP: Student Growth Percentiles & Percentile Growth Trajectories.",
-                    "(R package version 2.2-1.96)",
+                    "(R package version 2.2-1.98)",
                     "URL: https://sgp.io"
                   )
 )

inst/CITATION

@@ -19,8 +19,8 @@ growth projections to be calculated across assessment transitions by equating th
 \tabular{ll}{
 Package: \tab SGP\cr
 Type: \tab Package\cr
-Version: \tab 2.2-1.96\cr
-Date: \tab 2025-3-18\cr
+Version: \tab 2.2-1.98\cr
+Date: \tab 2025-4-14\cr
 License: \tab GPL-3\cr
 LazyLoad: \tab yes\cr
 }

man/SGP-package.Rd

@@ -27,6 +27,7 @@ rliSGP(
 	simulate.sgps=FALSE,
 	save.intermediate.results=FALSE,
 	coefficient.matrices=NULL,
+	coefficient.matrices.year=NULL,
 	goodness.of.fit.print=FALSE,
 	return.updated.shell=FALSE,
 	fix.duplicates="KEEP.ALL",
@@ -81,6 +82,8 @@ analysis. Default is NULL, no ID replacement is performed.
   }
   \item{coefficient.matrices}{List of baseline matrices to be used for analyses (overrides what exists in \code{SGPstateData}). Defaults to NULL (use those in \code{SGPstateData}).
   }
+  \item{coefficient.matrices.year}{Year associated with coefficient matrices to be used for analyses. Defaults to NULL which will use the most recent matrices calculated before the year provided in the data.
+  }
   \item{goodness.of.fit.print}{Boolean argument passed to \code{\link{updateSGP}} indicating whether to print goodness of fit plots associated with outcome. Default is FALSE.
   }
   \item{return.updated.shell}{Boolean argument (defaults to FALSE) indicating whether to return \code{sgp_object} as part of call to \code{rliSGP}.