Skip to content

Commit

Permalink
minor docs style
Browse files Browse the repository at this point in the history
  • Loading branch information
strengejacke committed Oct 15, 2024
1 parent 689d86f commit 6ce8b02
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
11 changes: 6 additions & 5 deletions R/bayesfactor.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
#'
#' This function compte the Bayes factors (BFs) that are appropriate to the
#' input. For vectors or single models, it will compute [`BFs for single
#' parameters()`][bayesfactor_parameters], or is `hypothesis` is specified,
#' [`BFs for restricted models()`][bayesfactor_restricted]. For multiple models,
#' parameters`][bayesfactor_parameters], or is `hypothesis` is specified,
#' [`BFs for restricted models`][bayesfactor_restricted]. For multiple models,
#' it will return the BF corresponding to [`comparison between
#' models()`][bayesfactor_models] and if a model comparison is passed, it will
#' compute the [`inclusion BF()`][bayesfactor_inclusion].
#' models`][bayesfactor_models] and if a model comparison is passed, it will
#' compute the [`inclusion BF`][bayesfactor_inclusion].
#' \cr\cr
#' For a complete overview of these functions, read the [Bayes factor vignette](https://easystats.github.io/bayestestR/articles/bayes_factors.html).

Check warning on line 11 in R/bayesfactor.R

View workflow job for this annotation

GitHub Actions / lint-changed-files / lint-changed-files

file=R/bayesfactor.R,line=11,col=121,[line_length_linter] Lines should not be more than 120 characters. This line is 148 characters.

Check warning on line 11 in R/bayesfactor.R

View workflow job for this annotation

GitHub Actions / lint / lint

file=R/bayesfactor.R,line=11,col=121,[line_length_linter] Lines should not be more than 120 characters. This line is 148 characters.
#'
Expand All @@ -17,7 +17,8 @@
#' @inheritParams bayesfactor_models
#' @inheritParams bayesfactor_inclusion
#'
#' @return Some type of Bayes factor, depending on the input. See [bayesfactor_parameters()], [bayesfactor_models()] or [bayesfactor_inclusion()]
#' @return Some type of Bayes factor, depending on the input. See
#' [`bayesfactor_parameters()`], [`bayesfactor_models()`] or [`bayesfactor_inclusion()`].
#'
#' @note There is also a [`plot()`-method](https://easystats.github.io/see/articles/bayestestR.html) implemented in the \href{https://easystats.github.io/see/}{\pkg{see}-package}.

Check warning on line 23 in R/bayesfactor.R

View workflow job for this annotation

GitHub Actions / lint-changed-files / lint-changed-files

file=R/bayesfactor.R,line=23,col=121,[line_length_linter] Lines should not be more than 120 characters. This line is 179 characters.

Check warning on line 23 in R/bayesfactor.R

View workflow job for this annotation

GitHub Actions / lint / lint

file=R/bayesfactor.R,line=23,col=121,[line_length_linter] Lines should not be more than 120 characters. This line is 179 characters.
#'
Expand Down
11 changes: 6 additions & 5 deletions man/bayesfactor.Rd

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

0 comments on commit 6ce8b02

Please sign in to comment.