Package 'Mustat'
Total Page:16
File Type:pdf, Size:1020Kb
Package ‘muStat’ February 20, 2015 Type Package Title Prentice Rank Sum Test and McNemar Test Version 1.7.0 Date 2010-09-17 Author Knut M. Wittkowski <[email protected]> and Tingting Song <[email protected]> Maintainer Benedetta Bigio <[email protected]> Depends R (>= 2.11.1), stats Description Performs Wilcox rank sum test, Kruskal rank sum test, Friedman rank sum test and McNemar test. License GPL (>= 2) URL http://mustat.rockefeller.edu Repository CRAN Date/Publication 2012-08-23 11:00:20 NeedsCompilation no R topics documented: muStat-package . .2 muS2RC-package . .4 muUtil-package . .5 anyMissing . .6 bits.per.integer . .6 chkMissing . .7 endfunction . .8 ifelse1 . .8 is.inf . .9 is.number . 10 is.orderable . 11 len.............................................. 12 MC ............................................. 12 1 2 muStat-package mu.AND . 13 mu.dbinom . 15 mu.GE . 16 mu.rank . 17 mu.Sums . 18 NAtoZer . 20 NoOp ............................................ 20 NoWarn . 21 prentice.test . 22 RCRng . 27 SMN.pvalue . 28 sq.array . 31 stdev............................................. 32 ULPrint . 33 which.na . 34 Index 35 muStat-package Prentice (Friedman/Wilcoxon/Kruskal) Rank Sum Test, Stratified Mc- Nemar (TDT, Sign) Test and u/mu-Scores for Multivariate Data Description Performs a generalized Friedman rank sum test with replicated blocked data or, as special cases, a Kruskal-Wallis rank sum test on data following a one-way layout, or a Wilcoxon rank sum test following a one-way layout with only two groups, or a stratified McNemar/sign test using a notion adopted to genetic association studies (TDT). Generates u/mu-scores of univariate and multivariate data to be used with these tests. Author Knut M. Wittkowski <[email protected]>, Tingting Song <[email protected]> Maintainer: Tingting Song <[email protected]> Details Package: muStat Type: Package Version: 1.6.0 Date: 2010-09-17 URL: http://mustat.rockefeller.edu License: GPL (>= 2) muStat-package 3 Copyright Software Transfer Agreement (adapted from the NIH Uniform Biological Materials Transfer Agreement, 64 FR 72090) \ In response to the RECIPIENT’s request for the software package muStat “SOFTWARE” the PROVIDER asks that the RECIPIENT agree to the following: 1. The SOFTWARE is the property of the PROVIDER and is made available as a service to the research community. 2. THE SOFTWARE WILL NOT BE USED FOR TREATING OR DIAGNOSING HUMAN SUBJECTS. 3. The SOFTWARE will be used for teaching or not-for-profit research purposes only. 4. The SOFTWARE will not be further distributed to others without the PROVIDER’s written consent, including any portion of the code incorporated into another work. The RECIPIENT shall refer any request for the SOFTWARE to the PROVIDER. PROVIDER agrees to make the SOFTWARE available, under a separate Agreement to other scientists for teaching or not- for-profit research purposes only. 5. The RECIPIENT agrees to acknowledge the source of the SOFTWARE in any publications reporting use of it. 6. THE PROVIDER MAKES NO REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER EXPRESSED OR IMPLIED. THERE ARE NO EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR THAT THE USE OF THE SOFTWARE WILL NOT INFRINGE ANY PATENT, COPYRIGHT, TRADEMARK, OR OTHER PROPRIETARY RIGHTS. Unless prohibited by law, RECIPIENT assumes all liability for claims for damages against it which may arise from the use of the SOFTWARE. 7. By registering at http://muStat.rockefeller.edu (“PROVIDER SCIENTIST WEB SITE”) the RECIPIENT obtains the right to receive revisions of the SOFTWARE and related infor- mation. 8. By downloading this SOFTWARE, the RECIPIENT agrees to the terms of this AGREEMENT. Provider Information: Provider Scientist: Knut M. Wittkowski, PhD, DSc <[email protected]> Provider: The Rockefeller University Address: 1230 York Ave, New York, NY 10021, U.S.A. Name of Authorized Official: Kathleen Denis <[email protected]> Title of Authorizing Official: Associate Vice President, Technology Transfer 4 muS2RC-package muS2RC-package Splus to R Compatibility for package muStat Description muR2SC contains functions that are needed by package muStat and either have different definitions in R and Splus, or defined in Splus while not in R. Details Package: muS2RC Type: Package Version: 1.6.0 Date: 2010-09-17 License: GPL (>= 2) Author(s) Knut M. Wittkowski <[email protected]>, Tingting Song <[email protected]> Maintainer: Tingting Song <[email protected]> Examples x <- c(1, 4, NA, 0, 5) anyMissing(x) # [1] TRUE chkMissing(x) # [1] TRUE which.na(x) # [1] 3 stdev(x, na.rm=TRUE, unbiased=TRUE) # [1] 2.380476 stdev(x, na.rm=TRUE, unbiased=FALSE) # [1] 1.904381 c <- 5 ifelse1(c>=0, 1, -1) # [1] 1 is.inf(Inf) # [1] TRUE is.inf(NA) # [1] FALSE is.inf(1) # [1] FALSE is.number(32) muUtil-package 5 # [1] TRUE is.number(matrix(1:20, nrow=2)) # [,1] [,2] [,3] [,4] [,5] [,6] [,7] [,8] [,9] [,10] # [1,] TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE # [2,] TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE is.number(list(matrix(1:20, nrow=2), 1:4)) # [1] TRUE TRUE is.number('s') # [1] TRUE f1 <- function(x, y) x+y f2 <- MC(function(x, y) x*y, list(f1=f1)) muUtil-package muStat Utility Functions Description This package contains a collection of utility functions for package muStat. For a complete list, use library(help="muUtil"). Details Package: muUtil Type: Package Version: 1.6.0 Date: 2010-09-17 License: GPL (>= 2) Author(s) Knut M. Wittkowski <[email protected]>, Tingting Song <[email protected]> Maintainer: Tingting Song <[email protected]> Examples x <- 5 NoOp(x) # [1] 5 len(c(1:20)) # [1] 20 6 bits.per.integer anyMissing Check for Missing Values. Description Check if there exist any missing values. Usage anyMissing(x) Arguments x data object Details Returns TRUE, if there are any NA’s. Author(s) Knut M. Wittkowski <[email protected]> See Also is.na, link{chkMissing} Examples x <- c(1, 4, NA, 0, 5) anyMissing(x) # [1] TRUE bits.per.integer Internal Size of an integer Description bits.per.integer tells the number of bits that an integer occupies. Usage bits.per.integer() Details Assigned to be 32 for the C programs chkMissing 7 Author(s) Knut M. Wittkowski <[email protected]> Examples bits.per.integer() ## The function is currently defined as function() 32 chkMissing Check Missing Data Description chkMissing always returns TRUE in R. If in Splus, it returns a logical value, indicating if there exsist NA’s in data Usage chkMissing(...) Arguments ... object to be tested Author(s) Knut M. Wittkowski <[email protected]> See Also is.na, link{anyMissing} Examples x <- c(1, 4, NA, 0, 5) chkMissing(x) # [1] TRUE 8 ifelse1 endfunction End a Function Description endfunction will return an invisible NULL, which could mark the end of a function. Usage endfunction(text) Arguments text any input Value Always returns NULL, which will not be printed. Author(s) Knut M. Wittkowski <[email protected]> See Also invisible Examples endfunction(f) ifelse1 Conditional Data Selection Description Places values into an object according to the logical values in test. Usage ifelse1(test, x, y, ...) Arguments test logical object. Missing values (NA) are allowed x action to be taken if test is TRUE y action to be taken if test is FALSE ... other is.inf 9 Details NA values in test cause NAs in the result. Compared with ifelse() in Splus, the length of test in ifelse1() is 1, which means ifelse1() will do only one test. Value x or y depending on test. Author(s) Knut M. Wittkowski <[email protected]> See Also if, ifelse Examples c <- 5 ifelse1(c>=0, 1, -1) # [1] 1 is.inf Infinite Description is.inf returns a vector of the same length as the input object, indicating which elements are infinite (not missing). Usage is.inf(...) Arguments ... object to be tested Details is.infinite returns a vector of the same length as x the jth element of which is TRUE if x[j] is infinite (i.e., equal to one of Inf or -Inf). This will be false unless x is numeric or complex. Complex numbers are infinite if either the real and imaginary part is. Author(s) Knut M. Wittkowski <[email protected]> 10 is.number See Also ~~objects to See Also as is.finite Examples is.inf(Inf) # [1] TRUE is.inf(NA) # [1] FALSE is.inf(1) # [1] FALSE is.number Check Values Description Returns TRUE if the value is finite or infinite, i.e., is neither missing (NA) nor not-a-number (Nan). It replicates the same behavior of the homonymous S+ function. Usage is.number(...) Arguments ... numeric vector Details is.number is TRUE if the value is finite or infinite, i.e., is neither missing ( NA) nor not-a-number ( NaN). Author(s) Knut M. Wittkowski <[email protected]> Examples is.number(32) # [1] TRUE is.number(matrix(1:20, nrow=2)) # [,1] [,2] [,3] [,4] [,5] [,6] [,7] [,8] [,9] [,10] # [1,] TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE # [2,] TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE is.number('s') # [1] FALSE is.orderable 11 is.orderable If a value can be ordered Description is.orderable() returns !is.na() Usage is.orderable(x) Arguments x object to be tested Details is.orderable(x) works elementwise when x is a list. Value is.orderable returns a logical vector of the same attribute as its argument x Author(s) Knut M. Wittkowski <[email protected]> See Also is.na Examples x <- c(1, 4, NA, 0, 5) is.orderable(x) # [1] TRUE TRUE FALSE TRUE TRUE 12 MC len Length of an Object Description Get the length of vectors (including lists) and factors, and of any other object for which a method has been defined.