Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
FBartos committed Oct 25, 2023
1 parent 485ca77 commit 6dd0cf5
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 10 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ License: GPL-3
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.1
RoxygenNote: 7.2.3
Imports:
Rcpp (>= 1.0.2),
nleqslv,
Expand Down
5 changes: 3 additions & 2 deletions R/main.R
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
#' "max_iter" = 9999,
#' "alpha" = .10
#' )
#' \donttest{m1.EM <- zcurve(OSC.z, method = "EM", bootstrap = FALSE, control = ctr1)}
#' \dontrun{m1.EM <- zcurve(OSC.z, method = "EM", bootstrap = FALSE, control = ctr1)}
#' # see '?control_EM' and '?control_density' for more information about different
#' # z-curves specifications
#' @seealso [summary.zcurve()], [plot.zcurve()], [control_EM], [control_density]
Expand Down Expand Up @@ -556,7 +556,7 @@ print.summary.zcurve <- function(x, ...){
#' @export plot.zcurve
#' @rawNamespace S3method(plot, zcurve)
#'
#' @examples
#' @examples \dontrun{
#' # simulate some z-statistics and fit a z-curve
#' z <- abs(rnorm(300,3))
#' m.EM <- zcurve(z, method = "EM", bootstrap = 100)
Expand All @@ -569,6 +569,7 @@ print.summary.zcurve <- function(x, ...){
#'
#' # change the location of the annotation to the left
#' plot(m.EM, annotation = TRUE, CI = TRUE, x_text = 0)
#' }
#' @seealso [zcurve()]
plot.zcurve <- function(x, annotation = FALSE, CI = FALSE, extrapolate = FALSE, plot_type = "base",
y.anno = c(.95, .88, .78, .71, .61, .53, .43, .35), x.anno = .6, cex.anno = 1, ...){
Expand Down
2 changes: 1 addition & 1 deletion R/zcurve_EM.R
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@
#' fit_reps = 50,
#' mu = c(0, 1.5, 3, 4.5, 6)
#' )
#' \donttest{zcurve(OSC.z, method = "EM", control = ctrl)}
#' \dontrun{zcurve(OSC.z, method = "EM", control = ctrl)}
#'
#' @seealso [zcurve()], [control_density]
NULL
Expand Down
4 changes: 2 additions & 2 deletions R/zcurve_density.R
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@
#' version = 1,
#' max_iter = 300
#' )
#' \donttest{zcurve(OSC.z, method = "density", control = ctrl)}
#' \dontrun{zcurve(OSC.z, method = "density", control = ctrl)}
#'
#' @seealso [zcurve()], [control_density], [control_EM]
NULL
Expand Down Expand Up @@ -349,7 +349,7 @@ NULL
#' max_iter = 300,
#' criterion = 1e-4
#' )
#' \donttest{zcurve(OSC.z, method = "density", control = ctrl)}
#' \dontrun{zcurve(OSC.z, method = "density", control = ctrl)}
#'
#' @seealso [zcurve()], [control_density_v1], [control_EM]
NULL
Expand Down
2 changes: 1 addition & 1 deletion man/control_EM.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/control_density.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/control_density_v1.Rd

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

2 changes: 2 additions & 0 deletions man/plot.zcurve.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/zcurve.Rd

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

0 comments on commit 6dd0cf5

Please sign in to comment.