Update roxygen docs files missed in #25 (#26)

* Update roxygen docs files missed in #25 * Fix missing gradient in Langevin example * Ignore .lintr config file to avoid R check note
UCL · Aug 2, 2024 · 788479f · 788479f
1 parent bf55eea
commit 788479f
Show file tree

Hide file tree

Showing 10 changed files with 185 additions and 4 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -6,3 +6,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^.lintr$
diff --git a/NAMESPACE b/NAMESPACE
@@ -3,6 +3,7 @@
 export(barker_proposal)
 export(chain_state)
 export(example_gaussian_stan_model)
+export(langevin_proposal)
 export(random_walk_proposal)
 export(robust_shape_adapter)
 export(sample_chain)

diff --git a/R/langevin.R b/R/langevin.R
@@ -55,7 +55,8 @@ log_density_ratio_langevin <- function(
 #'
 #' @examples
 #' target_distribution <- list(
-#'   log_density = function(x) -sum(x^2) / 2
+#'   log_density = function(x) -sum(x^2) / 2,
+#'   gradient_log_density = function(x) -x
 #' )
 #' proposal <- langevin_proposal(target_distribution, scale = 1.)
 #' state <- chain_state(c(0., 0.))

diff --git a/man/example_gaussian_stan_model.Rd b/man/example_gaussian_stan_model.Rd
diff --git a/man/involution_langevin.Rd b/man/involution_langevin.Rd
diff --git a/man/langevin_proposal.Rd b/man/langevin_proposal.Rd
diff --git a/man/log_density_ratio_langevin.Rd b/man/log_density_ratio_langevin.Rd
diff --git a/man/sample_langevin.Rd b/man/sample_langevin.Rd
diff --git a/man/sample_metropolis_hastings.Rd b/man/sample_metropolis_hastings.Rd
diff --git a/man/target_distribution_from_stan_model.Rd b/man/target_distribution_from_stan_model.Rd