add examples

qddyy · Oct 7, 2024 · 1fdf10c · 1fdf10c
1 parent a082653
commit 1fdf10c
Show file tree

Hide file tree

Showing 44 changed files with 501 additions and 536 deletions.
diff --git a/R/AnsariBradley.R b/R/AnsariBradley.R
@@ -4,7 +4,13 @@
 #' 
 #' @aliases twosample.ansari
 #' 
-#' @export AnsariBradley
+#' @examples
+#' pmt(
+#'     "twosample.ansari",
+#'     alternative = "greater", n_permu = 0
+#' )$test(Table2.8.1)$print()
+#' 
+#' @export
 #' 
 #' @importFrom R6 R6Class
 #' @importFrom stats pnorm

diff --git a/R/CDF.R b/R/CDF.R
@@ -4,6 +4,9 @@
 #' 
 #' @aliases onesample.cdf
 #' 
+#' @examples
+#' pmt("onesample.cdf")$test(Table1.2.1)$plot(style = "graphic")
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/ChiSquare.R b/R/ChiSquare.R
@@ -4,6 +4,14 @@
 #' 
 #' @aliases table.chisq
 #' 
+#' @examples
+#' t <- pmt(
+#'     "table.chisq", n_permu = 0
+#' )$test(Table5.4.2)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/Correlation.R b/R/Correlation.R
@@ -4,6 +4,28 @@
 #' 
 #' @aliases association.corr
 #' 
+#' @examples
+#' pmt(
+#'     "association.corr", method = "pearson",
+#'     alternative = "greater", n_permu = 10000
+#' )$test(Table5.1.2)$print()
+#' 
+#' t <- pmt(
+#'     "association.corr", method = "spearman",
+#'     alternative = "two_sided", n_permu = 10000
+#' )$test(Table5.1.2)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
+#' t <- pmt(
+#'     "association.corr", method = "kendall",
+#'     alternative = "greater", n_permu = 0
+#' )$test(Table5.2.2)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/Difference.R b/R/Difference.R
@@ -4,6 +4,19 @@
 #' 
 #' @aliases twosample.difference
 #' 
+#' @examples
+#' pmt(
+#'     "twosample.difference", method = "mean",
+#'     alternative = "greater", n_permu = 0
+#' )$test(Table2.1.1)$print()$plot(
+#'     style = "graphic", breaks = seq(-20, 25, length.out = 9)
+#' )
+#' 
+#' pmt(
+#'     "twosample.difference", method = "mean",
+#'     alternative = "greater", n_permu = 1000
+#' )$test(Table2.3.1)$print()
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/Friedman.R b/R/Friedman.R
@@ -4,6 +4,14 @@
 #' 
 #' @aliases rcbd.friedman
 #' 
+#' @examples
+#' t <- pmt(
+#'     "rcbd.friedman", n_permu = 0
+#' )$test(Table4.5.3)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/JonckheereTerpstra.R b/R/JonckheereTerpstra.R
@@ -4,6 +4,14 @@
 #' 
 #' @aliases ksample.jt
 #' 
+#' @examples
+#' t <- pmt(
+#'     "ksample.jt", alternative = "greater"
+#' )$test(Table3.4.1)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/KolmogorovSmirnov.R b/R/KolmogorovSmirnov.R
@@ -4,6 +4,11 @@
 #' 
 #' @aliases twosample.ks
 #' 
+#' @examples
+#' pmt(
+#'     "twosample.ks", n_permu = 0
+#' )$test(Table2.8.1)$print()
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/KruskalWallis.R b/R/KruskalWallis.R
@@ -4,6 +4,18 @@
 #' 
 #' @aliases ksample.kw
 #' 
+#' @examples
+#' pmt(
+#'     "ksample.kw", type = "asymp"
+#' )$test(Table3.2.2)$print()
+#' 
+#' t <- pmt(
+#'     "ksample.kw", type = "permu"
+#' )$test(Table3.2.3)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/OneWay.R b/R/OneWay.R
@@ -4,6 +4,14 @@
 #' 
 #' @aliases ksample.oneway
 #' 
+#' @examples
+#' t <- pmt(
+#'     "ksample.oneway", n_permu = 0
+#' )$test(Table3.1.2)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/Page.R b/R/Page.R
@@ -4,6 +4,14 @@
 #' 
 #' @aliases rcbd.page
 #' 
+#' @examples
+#' t <- pmt(
+#'     "rcbd.page", alternative = "less"
+#' )$test(Table4.4.3)
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/PairedDifference.R b/R/PairedDifference.R
@@ -4,6 +4,24 @@
 #' 
 #' @aliases paired.difference
 #' 
+#' @examples
+#' pmt(
+#'     "paired.difference",
+#'     alternative = "greater", scoring = "none", n_permu = 0
+#' )$test(Table4.1.1)$print()
+#' 
+#' pmt(
+#'     "paired.difference", n_permu = 0
+#' )$test(Table4.1.3)$print()
+#' 
+#' t <- pmt(
+#'     "paired.difference", scoring = "rank",
+#'     alternative = "greater", n_permu = 0
+#' )$test(Table4.1.1)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/Quantile.R b/R/Quantile.R
@@ -4,6 +4,18 @@
 #' 
 #' @aliases onesample.quantile
 #' 
+#' @examples
+#' pmt(
+#'     "onesample.quantile", prob = 0.5,
+#'     null_value = 75, alternative = "greater",
+#'     type = "asymp", correct = FALSE
+#' )$test(Table1.1.1)$print()
+#' 
+#' pmt(
+#'     "onesample.quantile",
+#'     prob = 0.25, conf_level = 0.90
+#' )$test(Table1.2.1)$conf_int
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/RCBDOneWay.R b/R/RCBDOneWay.R
@@ -4,6 +4,14 @@
 #' 
 #' @aliases rcbd.oneway
 #' 
+#' @examples
+#' t <- pmt(
+#'     "rcbd.oneway", n_permu = 5000
+#' )$test(Table4.4.3)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/RatioMeanDeviance.R b/R/RatioMeanDeviance.R
@@ -4,6 +4,12 @@
 #' 
 #' @aliases twosample.rmd
 #' 
+#' @examples
+#' pmt(
+#'     "twosample.rmd",
+#'     alternative = "greater", n_permu = 0
+#' )$test(Table2.8.1)$print()
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/ScoreSum.R b/R/ScoreSum.R
@@ -4,6 +4,12 @@
 #' 
 #' @aliases twosample.scoresum
 #' 
+#' @examples
+#' pmt(
+#'     "twosample.scoresum", scoring = "expon",
+#'     alternative = "greater", n_permu = 0
+#' )$test(Table2.6.2)$print()
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/SiegelTukey.R b/R/SiegelTukey.R
@@ -4,7 +4,13 @@
 #' 
 #' @aliases twosample.siegel
 #' 
-#' @export SiegelTukey
+#' @examples
+#' pmt(
+#'     "twosample.siegel",
+#'     alternative = "greater", n_permu = 0
+#' )$test(Table2.8.1)$print()
+#' 
+#' @export
 #' 
 #' @importFrom R6 R6Class
 

diff --git a/R/Sign.R b/R/Sign.R
@@ -4,6 +4,17 @@
 #' 
 #' @aliases paired.sign
 #' 
+#' @examples
+#' t <- pmt(
+#'     "paired.sign",
+#'     alternative = "greater", n_permu = 0
+#' )$test(
+#'     rep(c(+1, -1), c(12, 5)), rep(0, 17)
+#' )$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/Studentized.R b/R/Studentized.R
@@ -4,6 +4,26 @@
 #' 
 #' @aliases multcomp.studentized
 #' 
+#' @examples
+#' t <- pmt(
+#'     "multcomp.studentized", method = "bonferroni"
+#' )$test(Table3.3.1)$print()
+#' 
+#' t$type <- "asymp"
+#' t
+#' 
+#' t$scoring <- "rank"
+#' t
+#' 
+#' t$method <- "tukey"
+#' t
+#' 
+#' t$scoring <- "none"
+#' t
+#' 
+#' t$type <- "permu"
+#' t
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class

diff --git a/R/Wilcoxon.R b/R/Wilcoxon.R
@@ -4,6 +4,21 @@
 #' 
 #' @aliases twosample.wilcoxon
 #' 
+#' @examples
+#' pmt(
+#'     "twosample.wilcoxon",
+#'     alternative = "greater", n_permu = 0
+#' )$test(Table2.1.1)$print()
+#' 
+#' pmt(
+#'     "twosample.wilcoxon",
+#'     alternative = "less", n_permu = 0
+#' )$test(Table2.6.1)$print()
+#' 
+#' pmt(
+#'     "twosample.wilcoxon", conf_level = 0.90
+#' )$test(Table2.6.2)$conf_int
+#' 
 #' @export
 #' 
 #' @importFrom R6 R6Class