splinef

+ make_function.splinef and makepar_F_splinef added
dd-harp · Jan 29, 2025 · f8ce01a · f8ce01a
1 parent f6e7c0e
commit f8ce01a
Show file tree

Hide file tree

Showing 11 changed files with 112 additions and 3 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -230,6 +230,7 @@ S3method(make_function,product)
 S3method(make_function,sharkfin)
 S3method(make_function,sigmoid)
 S3method(make_function,sin)
+S3method(make_function,splinef)
 S3method(make_function,sum)
 S3method(make_runtime,dts)
 S3method(make_runtime,xde)
@@ -545,6 +546,7 @@ export(makepar_F_product)
 export(makepar_F_sharkfin)
 export(makepar_F_sigmoid)
 export(makepar_F_sin)
+export(makepar_F_splinef)
 export(makepar_F_sum)
 export(metric_calD)
 export(metric_calR)

diff --git a/R/functions.R b/R/functions.R
@@ -228,3 +228,32 @@ makepar_F_sharkfin = function(D=100, L=180, uk = 1/7, dk=1/40, pw=1, mx=1, N=1){
   pars$N = N
   return(pars)
 }
+
+
+#' @title Make a spline function
+#' @description A spline function passes time points `tt` and
+#' associated values `yy` and returns a spline function 
+#' @inheritParams make_function
+#' @return a function
+#' @export
+make_function.splinef = function(opts){
+  ff <- function(t){
+    stats::spline(opts$tt, opts$yy, xout = t)$y
+  }
+  return(ff)
+}
+
+
+#' @title Make Parameters for a Spline 
+#' @description Return an object for [make_function.splinef]
+#' @param tt the nodes 
+#' @param yy the y values 
+#' @return parameters to configure the `splinef` case of `make_function`
+#' @export
+makepar_F_splinef = function(tt, yy){
+  pars <- list()
+  class(pars) = "splinef"
+  pars$tt = tt
+  pars$yy = yy 
+  return(pars)
+}
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -1111,6 +1111,8 @@ reference:
   - makepar_F_sigmoid
   - make_function.sharkfin
   - makepar_F_sharkfin
+  - make_function.splinef
+  - makepar_F_splinef
 - subtitle: New
   desc: |
     Basic visualization of the transmission terms

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -23,7 +23,7 @@ articles:
   TraceFunctions: TraceFunctions.html
   Understanding_ramp.xds: Understanding_ramp.xds.html
   Working: Working.html
-last_built: 2024-12-16T22:33Z
+last_built: 2025-01-28T23:38Z
 urls:
   reference: https://dd-harp.github.io/ramp.xds/reference
   article: https://dd-harp.github.io/ramp.xds/articles

diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/xds_solve_cohort.html b/docs/reference/xds_solve_cohort.html
diff --git a/man/make_function.sin.Rd b/man/make_function.sin.Rd
diff --git a/man/make_function.splinef.Rd b/man/make_function.splinef.Rd
diff --git a/man/makepar_F_splinef.Rd b/man/makepar_F_splinef.Rd
diff --git a/man/xds_solve_cohort.Rd b/man/xds_solve_cohort.Rd
diff --git a/vignettes/TraceFunctions.Rmd b/vignettes/TraceFunctions.Rmd
@@ -219,3 +219,23 @@ C2t <- C2(tt)
 plot(tt, C2t[1,], type ="l", xlab = "Time (in Days)", ylab = expression(Fs1(t)))
 lines(tt, C2t[2,])
 ```
+
+### Spline
+
+
+```{r}
+tv = c(-1:6)*365/4
+yv = c(1/2, 1, 2, 1, 1/3, 1, 3, 1) 
+sp0 <- makepar_F_splinef(tv, yv)
+```
+
+
+```{r}
+ff <- make_function(sp0)
+```
+
+
+```{r}
+plot(tt, ff(tt), type = "l")
+```
+