added data set

NAMESPACE

@@ -1,5 +1,5 @@
 useDynLib(pseudorank, .registration=TRUE)
-export(psrank, pseudorank, hettmansperger_norton_test, kruskal_wallis_test, kepner_robinson_test)
+export(psrank, pseudorank, hettmansperger_norton_test, kruskal_wallis_test)
 S3method(pseudorank, numeric)
 S3method(pseudorank, formula)
 S3method(print, pseudorank)

NEWS.md

@@ -1,9 +1,6 @@
 # pseudorank 0.3.6
 * Changed function name ''psrank'' to ''pseudorank'' and set ''psrank'' as deprecated.
-
-# pseudorank 0.3.5
-* Added the Kepner-Robinson test for one-sample problems in repeated measures designs with compound symmetry covariance structure.
-
+* Added a data set which can be used to show paradoxical results from rank tests.
 
 # pseudorank 0.3.0
 

R/S3method.R

@@ -161,22 +161,22 @@ kruskal_wallis_test.formula <- function(formula, data, na.rm = FALSE, pseudorank
 #' @return Returns an object of class 'pseudorank'
 #' @example R/example_4.txt
 #' @references James L. Kepner & David H. Robinson (1988) Nonparametric Methods for Detecting Treatment Effects in Repeated-Measures Designs, Journal of the American Statistical Association, 83:402, 456-461.
-#' @keywords export
+#' @keywords internal
 kepner_robinson_test <- function(x, ...) {
   UseMethod("kepner_robinson_test")
 }
 
 #' @method kepner_robinson_test numeric
 #' @rdname kepner_robinson_test
-#' @keywords export
+#' @keywords internal
 kepner_robinson_test.numeric <- function(x, time, subject, na.rm = FALSE, distribution = c("Chisq", "F"), ...) {
   distribution = match.arg(distribution)
   return(kepner_robinson_test_internal(data=x, time=as.factor(time), subject=as.factor(subject), na.rm = na.rm, distribution = distribution, formula = NULL, ...))
 }
 
 #' @method kepner_robinson_test formula
 #' @rdname kepner_robinson_test
-#' @keywords export
+#' @keywords internal
 kepner_robinson_test.formula <- function(formula, data, subject, na.rm = FALSE, distribution = c("Chisq", "F"), ...) {
   stopifnot(is.character(subject))
   distribution = match.arg(distribution)

R/data.R

@@ -0,0 +1,24 @@
+################################################################################
+### File: data.R
+### Description: data object
+###
+################################################################################
+
+#' Artifical data of 54 subjects
+#'
+#' An artificial dataset containing data of 54 subjects where where a substance was administered in three different concentrations (1,2 and 3).
+#' This data set can be used to show the paradoxical results obtained from rank tests, i.e., the Hettmansperger-Norton test.
+#'
+#' The columns are as follows:
+#' \itemize{
+#'   \item conc. Grouping variable specifying which concentration was used. This factor is ordered, i.e., 1 < 2 < 3.
+#'   \item score. The response variable.
+#' }
+#'
+#' @docType data
+#' @keywords datasets
+#' @name ParadoxicalRanks
+#' @usage data(ParadoxicalRanks)
+#' @format A data frame with 54 rows and 2 variables.
+#' @example R/example_paradoxical_results.txt
+"ParadoxicalRanks"

R/example_paradoxical_results.txt

@@ -0,0 +1,20 @@
+data("ParadoxicalRanks")
+dat <- ParadoxicalRanks
+
+set.seed(1)
+n <- c(60, 360, 120)
+x1 <- sample(subset(dat, dat$conc == 1)$score, n[1], replace = TRUE)
+x2 <- sample(subset(dat, dat$conc == 2)$score, n[2], replace = TRUE)
+x3 <- sample(subset(dat, dat$conc == 3)$score, n[3], replace = TRUE)
+
+
+dat <- data.frame(score = c(x1, x2, x3),
+  conc = factor(c( rep(1,n[1]), rep(2,n[2]), rep(5,n[3]) ), ordered=T) )
+
+# Hettmansperger-Norton test with ranks (pseudorannks = FALSE) returns a small p-value (0.011).
+# In contrast, the pseudo-rank test returns a large p-value (0.42). By changing the ratio of
+# group sizes, we can also obtain a significant decreasing trend with ranks.
+hettmansperger_norton_test(score ~ conc, data = dat, pseudoranks = FALSE,
+  alternative = "increasing")
+hettmansperger_norton_test(score ~ conc, data = dat, pseudoranks = TRUE,
+  alternative = "increasing")

README.md

@@ -1,4 +1,4 @@
-# pseudorank 0.3.5
+# pseudorank 0.3.6
 
 [![CRANstatus](https://www.r-pkg.org/badges/version/pseudorank)](https://cran.r-project.org/package=pseudorank)
 [![](https://cranlogs.r-pkg.org/badges/pseudorank)](https://cran.r-project.org/package=pseudorank)