add a method a update docs

TARGENE · Jan 3, 2023 · 9fd9188 · 9fd9188
1 parent dc2a987
commit 9fd9188
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/docs/src/user_guide.md b/docs/src/user_guide.md
@@ -323,6 +323,6 @@ nothing # hide
 
 Since we have only updated $G$'s specification, only this model is fitted again.
 
-### Scenario N
+### General behaviour
 
-Feel free to play around with the cache and to report any non consistent behaviour.
+Any change to either the `Parameter` of interest or the `NuisanceSpec` structures will trigger an update of the cache.
diff --git a/src/cache.jl b/src/cache.jl
@@ -140,4 +140,15 @@ while potentially reusing cached nuisance parameters.
 function tmle!(cache::TMLECache, Ψ::Parameter, η_spec::NuisanceSpec; verbosity=1, threshold=1e-8)
     update!(cache, Ψ, η_spec)
     tmle!(cache, verbosity=verbosity, threshold=threshold)
+end
+
+"""
+    tmle!(cache::TMLECache, η_spec::NuisanceSpec, Ψ::Parameter; verbosity=1, threshold=1e-8)
+
+Runs the TMLE procedure for the new parameter Ψ and the new nuisance parameters specification η_spec 
+while potentially reusing cached nuisance parameters.
+"""
+function tmle!(cache::TMLECache, η_spec::NuisanceSpec, Ψ::Parameter; verbosity=1, threshold=1e-8)
+    update!(cache, Ψ, η_spec)
+    tmle!(cache, verbosity=verbosity, threshold=threshold)
 end