20250706 - adjust sourdough fermentation and proofing times

Author: isaactpetersen

CITATION.cff

@@ -30,5 +30,5 @@ keywords:
   - R-package
   - psychometrics
 license: MIT
-version: 1.1.6
+version: 1.1.7
 date-released: '2025-02-02'

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: petersenlab
 Type: Package
 Title: A Collection of R Functions by the Petersen Lab
-Version: 1.1.6
+Version: 1.1.7
 Authors@R: c(
     person("Isaac T.", "Petersen",
            email = "isaac-t-petersen@uiowa.edu",

NAMESPACE

@@ -7,6 +7,7 @@ export(accuracyAtCutoff)
 export(accuracyAtEachCutoff)
 export(accuracyOverall)
 export(addText)
+export(adjust_sourdough_time)
 export(apa)
 export(attenuationCorrelation)
 export(cleanUpNames)

R/sourdoughRecipeTimes.R

@@ -0,0 +1,59 @@
+#' @title
+#' Adjust Sourdough Recipe Fermentation and Proofing Times Based on Temperature
+#'
+#' @description
+#' Adjust sourdough recipe fermentation and proofing times based on temperature.
+#'
+#' @details
+#' Adjusts sourdough recipe fermentation and proofing times based on ambient
+#' temperature. Suggested times are calculated using the \eqn{Q_{10}}
+#' temperature coefficient, which describes how the rate of fermentation changes
+#' with a 10°C temperature difference.
+#'
+#' @param original_time The original time(s) specified in the original recipe.
+#' @param recipe_temp The intended ambient temperature in the original recipe.
+#' @param actual_temp The actual ambient temperature used.
+#' @param q10 The \eqn{Q_{10}} temperature coefficient (describes rate change
+#' per 10°C).
+#' @param temp_unit "F" for Fahrenheit; "C" for Celsius.
+#'
+#' @return The adjusted sourdough fermentation or proofing time(s).
+#'
+#' @family baking
+#'
+#' @export
+#'
+#' @examples
+#' adjust_sourdough_time(
+#'   original_time = c(12, 15, 18),
+#'   recipe_temp = 70,
+#'   actual_temp = 75
+#'   )
+#'
+#' @seealso
+#' \url{https://en.wikipedia.org/wiki/Q10_(temperature_coefficient)}
+
+adjust_sourdough_time <- function(
+    original_time,
+    recipe_temp,
+    actual_temp,
+    q10 = 2,
+    temp_unit = c("F","C")) {
+
+  # Match argument for temperature unit
+  temp_unit <- match.arg(temp_unit)
+
+  # Convert to Celsius if input is in Fahrenheit
+  if (temp_unit == "F") {
+    recipe_temp <- (recipe_temp - 32) * 5 / 9
+    actual_temp <- (actual_temp - 32) * 5 / 9
+  }
+
+  # Calculate the adjustment factor
+  adjustment_factor <- q10 ^ ((recipe_temp - actual_temp) / 10)
+
+  # Return the new time
+  new_time <- original_time * adjustment_factor
+
+  return(new_time)
+}

README.md

@@ -37,7 +37,7 @@ A list of the functions included in the package is here: https://devpsylab.githu
 
 To obtain the citation for the `petersenlab` package, run `citation("petersenlab")`; the citation is:
 
-Petersen, I. T. (2025). *petersenlab: A collection of R functions by the Petersen Lab*. R package version 1.1.6. https://github.com/DevPsyLab/petersenlab, https://doi.org/10.32614/CRAN.package.petersenlab
+Petersen, I. T. (2025). *petersenlab: A collection of R functions by the Petersen Lab*. R package version 1.1.7. https://github.com/DevPsyLab/petersenlab, https://doi.org/10.32614/CRAN.package.petersenlab
 
 A `BibTeX` entry for `LaTeX` users is:
 ```
@@ -46,7 +46,7 @@ A `BibTeX` entry for `LaTeX` users is:
   title = {{petersenlab}: A collection of {R} functions by the {Petersen Lab}},
   url = {https://github.com/DevPsyLab/petersenlab},
   doi = {10.32614/CRAN.package.petersenlab},
-  version = {1.1.6},
+  version = {1.1.7},
   year = {2025}
 }
 ```

_pkgdown.yml

@@ -168,6 +168,10 @@ reference:
 
 - title: Miscellaneous
 
+- subtitle: Baking
+  contents:
+  - adjust_sourdough_time
+
 - subtitle: Fantasy Football
   contents:
   - cleanUpNames

inst/CITATION

@@ -7,7 +7,7 @@ bibentry(
            comment = c(ORCID = "0000-0003-3072-6673"))),
   year     = 2025,
   doi      = "10.32614/CRAN.package.petersenlab",
-  note     = "R package version 1.1.6, https://devpsylab.github.io/petersenlab/",
+  note     = "R package version 1.1.7, https://devpsylab.github.io/petersenlab/",
   url      = "https://github.com/DevPsyLab/petersenlab",
   key      = "petersenlab"
 )