Skip to content

Commit

Permalink
docs: update seealso tags to function calls
Browse files Browse the repository at this point in the history
  • Loading branch information
japhir committed May 20, 2024
1 parent 9afb404 commit 58f1337
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 12 deletions.
4 changes: 2 additions & 2 deletions R/calibration.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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,
Expand Down
5 changes: 3 additions & 2 deletions R/temperature_calculation.R
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
5 changes: 3 additions & 2 deletions R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/revcal.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/tempcal.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions man/temperature_axis.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions man/temperature_calculation.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 58f1337

Please sign in to comment.