Adding sgp.quantiles argument to baselineSGP function

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.993
+version: 2.2-1.994
 doi: 10.5281/zenodo.13921157
-date-released: 2025-5-5
+date-released: 2025-5-12
 url: "https://sgp.io"

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: SGP
 Type: Package
 Title: Student Growth Percentiles & Percentile Growth Trajectories
-Version: 2.2-1.993
-Date: 2025-5-5
+Version: 2.2-1.994
+Date: 2025-5-12
 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/baselineSGP.R

@@ -12,6 +12,7 @@ function(sgp_object,
 		return.matrices.only=FALSE,
 		calculate.baseline.sgps=TRUE,
 		calculate.simex.baseline=NULL,
+		sgp.quantiles="Percentiles",
 		goodness.of.fit.print=TRUE,
 		parallel.config=NULL,
 		SGPt=NULL,
@@ -167,6 +168,7 @@ function(sgp_object,
 				print.time.taken=FALSE,
 				parallel.config=parallel.config,
 				calculate.simex=tmp.simex.args,
+				sgp.quantiles=sgp.quantiles,
 				SGPt=SGPt,
 				...)[["Coefficient_Matrices"]])
 
@@ -320,6 +322,7 @@ function(sgp_object,
 					drop.nonsequential.grade.progression.variables=FALSE,
 					exact.grade.progression.sequence=sgp.iter[['sgp.exact.grade.progression']],
 					sgp.loss.hoss.adjustment=sgp.loss.hoss.adjustment,
+					sgp.quantiles=sgp.quantiles,
 					SGPt=SGPt,
 					...)
 

R/zzz.R

@@ -41,7 +41,7 @@ function(libname, pkgname) {
 
         # Define a friendly startup message
 		message_text <- paste0(
-		    magenta(bold("\uD83C\uDF89 SGP v", installed.version, sep="")), " - ", toOrdinal::toOrdinalDate("2025-5-5"), "\n",
+		    magenta(bold("\uD83C\uDF89 SGP v", installed.version, sep="")), " - ", toOrdinal::toOrdinalDate("2025-5-12"), "\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.993-brightgreen.svg)](https://github.com/CenterForAssessment/SGP)
+[![Development Version](https://img.shields.io/badge/devel-2.2--1.994-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)

inst/CITATION

@@ -9,12 +9,12 @@ bibentry(
                     person(given = c("Yi"), family = "Shang")
                    ),
     year         = "2025",
-    note         = "R package version 2.2-1.993",
+    note         = "R package version 2.2-1.994",
     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.993)",
+                    "(R package version 2.2-1.994)",
                     "URL: https://sgp.io"
                   )
 )

man/SGP-package.Rd

@@ -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.993\cr
-Date: \tab 2025-5-5\cr
+Version: \tab 2.2-1.994\cr
+Date: \tab 2025-5-12\cr
 License: \tab GPL-3\cr
 LazyLoad: \tab yes\cr
 }

man/baselineSGP.Rd

@@ -19,6 +19,7 @@ Utility function/exemplar used to produce student growth percentiles using long
         return.matrices.only=FALSE,
         calculate.baseline.sgps=TRUE,
         calculate.simex.baseline=NULL,
+        sgp.quantiles="Percentiles",
         goodness.of.fit.print=TRUE,
         parallel.config=NULL,
         SGPt=NULL,
@@ -53,6 +54,8 @@ To utilize the maximum matrix order, set to NULL.
   }
   \item{calculate.simex.baseline}{A list including state/csem variable, csem.data.vnames, csem.loss.hoss, simulation.iterations, lambda and extrapolation method. Defaults to NULL, no simex calculations performed.  Alternatively, setting the argument to TRUE sets the list up with state=state, lambda=seq(0,2,0.5), simulation.iterations=50, simex.sample.size=25000, extrapolation="linear" and save.matrices=TRUE.
   }
+  \item{sgp.quantiles}{Argument to specify quantiles for quantile regression estimation. Default is Percentiles. User can additionally submit a vector of quantiles (between 0 and 1). Goodness of fit output only available currently for PERCENTILES.
+  }
   \item{goodness.of.fit.print}{Boolean variable indicating whether the function will export goodness of fit plots if baseline referenced student growth percentiles are calculated. Defaults to TRUE.
   }
   \item{parallel.config}{parallel configuration argument allowing for parallel analysis by 'tau'. Defaults to NULL.