From 58f1337adb1b10ed20a74a7f3950309d7adfdc27 Mon Sep 17 00:00:00 2001
From: Ilja Kocken <i.j.kocken@uu.nl>
Date: Mon, 20 May 2024 10:04:13 -1000
Subject: [PATCH] docs: update seealso tags to function calls

---
 R/calibration.R                | 4 ++--
 R/temperature_calculation.R    | 5 +++--
 R/utils.R                      | 5 +++--
 man/revcal.Rd                  | 2 +-
 man/tempcal.Rd                 | 2 +-
 man/temperature_axis.Rd        | 6 ++++--
 man/temperature_calculation.Rd | 6 ++++--
 7 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/R/calibration.R b/R/calibration.R
index 36d19ac..f52e8e3 100644
--- a/R/calibration.R
+++ b/R/calibration.R
@@ -16,7 +16,7 @@
 #'   calibration.
 #' @return A [tibble][tibble::tibble-package] with input Tc and estimated
 #'   \eqn{\Delta_47} value with lower and upper bounds.
-#' @seealso revcal
+#' @seealso revcal()
 #' @export
 #' @references M. Bonifacie, D. Calmels, J. M. Eiler, J. Horita, C. Chaduteau,
 #'   C. Vasconcelos, P. Agrinier, A. Katz, B. H. Passey, J. M. Ferry, J.
@@ -68,7 +68,7 @@ tempcal <- function(Tc,
 #' @inheritParams tempcal
 #' @return A tibble with input \eqn{\Delta_{47}} and estimated Tc value
 #'   with lower and upper bounds.
-#' @seealso tempcal
+#' @seealso tempcal()
 #' @export
 revcal <- function(D47,
                    slope = 0.0449, intercept = 0.167,
diff --git a/R/temperature_calculation.R b/R/temperature_calculation.R
index d1e969a..23da261 100644
--- a/R/temperature_calculation.R
+++ b/R/temperature_calculation.R
@@ -5,13 +5,14 @@
 #' the regression.
 #'
 #' @param .data A [tibble][tibble::tibble-package], resulting from [acid_fractionation()].
-#' @param D47 The column name of the \eqn{\Delta_47} values to use as input.
+#' @param D47 The column name of the \eqn{\Delta_{47}} values to use as input.
 #' @param temp The column name of the output temperature.
 #' @param slope Character(1) column name with the slope.
 #' @param intercept Character(1) column name with the intercept.
 #' @inheritParams rlang::args_dots_empty
 #' @inheritParams quiet
-#' @seealso revcal tempcal
+#' @seealso revcal()
+#' @seealso tempcal()
 #' @export
 temperature_calculation <- function(.data, ...,
                                     D47 = D47_final, temp = temperature,
diff --git a/R/utils.R b/R/utils.R
index 0e9937e..9b0e378 100644
--- a/R/utils.R
+++ b/R/utils.R
@@ -15,8 +15,9 @@
 #'   ggplot2::geom_point() +
 #'   # generate the formula for temperature on the fly
 #'   ggplot2::scale_y_continuous(sec.axis = ggplot2::sec_axis(temperature_axis()))
-#' @seealso revcal
-#' @seealso tempcal
+#' @seealso temperature_calculation()
+#' @seealso revcal()
+#' @seealso tempcal()
 #' @export
 temperature_axis <- function(slope = 0.0449, intercept = 0.167) {
       ~ sqrt((slope * 1e6) / (. - intercept)) - 273.15
diff --git a/man/revcal.Rd b/man/revcal.Rd
index 7b254eb..7a29e9d 100644
--- a/man/revcal.Rd
+++ b/man/revcal.Rd
@@ -43,5 +43,5 @@ Defaults to Bonifacie et al. 2017 \deqn{\Delta_47 = (0.0449 \pm 0.001 \times
 10^6) / T^2 + (0.167 \pm 0.01)}
 }
 \seealso{
-tempcal
+tempcal()
 }
diff --git a/man/tempcal.Rd b/man/tempcal.Rd
index 2f73e3f..f86e469 100644
--- a/man/tempcal.Rd
+++ b/man/tempcal.Rd
@@ -48,5 +48,5 @@ to 350 \eqn{^\circ}C, and implications for a universal calibration for all (Ca,
 Fe)CO\eqn{{}_3} carbonates. \strong{2017}, \emph{200}, 255--279.
 }
 \seealso{
-revcal
+revcal()
 }
diff --git a/man/temperature_axis.Rd b/man/temperature_axis.Rd
index 9095bd4..9dc643e 100644
--- a/man/temperature_axis.Rd
+++ b/man/temperature_axis.Rd
@@ -28,7 +28,9 @@ ggplot2::ggplot(dat, ggplot2::aes(x = age, y = D47)) +
   ggplot2::scale_y_continuous(sec.axis = ggplot2::sec_axis(temperature_axis()))
 }
 \seealso{
-revcal
+temperature_calculation()
 
-tempcal
+revcal()
+
+tempcal()
 }
diff --git a/man/temperature_calculation.Rd b/man/temperature_calculation.Rd
index 738bd26..bde3573 100644
--- a/man/temperature_calculation.Rd
+++ b/man/temperature_calculation.Rd
@@ -19,7 +19,7 @@ temperature_calculation(
 
 \item{...}{These dots are for future extensions and must be empty.}
 
-\item{D47}{The column name of the \eqn{\Delta_47} values to use as input.}
+\item{D47}{The column name of the \eqn{\Delta_{47}} values to use as input.}
 
 \item{temp}{The column name of the output temperature.}
 
@@ -35,5 +35,7 @@ This uses the \code{\link[=revcal]{revcal()}} function to calculate temperatures
 the regression.
 }
 \seealso{
-revcal tempcal
+revcal()
+
+tempcal()
 }