corls_test.Rd 1.44 KB
 Eric Coissac committed May 27, 2019 1 2 % Generated by roxygen2: do not edit by hand % Please edit documentation in R/corls_test.R  Eric Coissac committed Oct 01, 2019 3 4 \name{corls_test} \alias{corls_test}  Eric Coissac committed Aug 23, 2019 5 \title{Monte-Carlo Test on the sum of the singular values of a procustean rotation.}  Eric Coissac committed May 27, 2019 6 \usage{  Eric Coissac committed Oct 01, 2019 7 corls_test(..., permutations = permute::how(nperm = 999),  Eric Coissac committed Oct 01, 2019 8  p_adjust_method = "holm")  Eric Coissac committed May 27, 2019 9 }  Eric Coissac committed Aug 23, 2019 10 \arguments{  Eric Coissac committed Oct 01, 2019 11 \item{...}{the set of matrices or a \code{\link[ProcMod]{procmod_frame}}  Eric Coissac committed Aug 23, 2019 12 13 14 15 16 17 object.} \item{permutations}{a list of control values for the permutations as returned by the function \code{\link[permute]{how}}, or the number of permutations required.}  Eric Coissac committed Oct 01, 2019 18 19 \item{p_adjust_method}{the multiple test correction method used to adjust p values. \code{p_adjust_method}  Eric Coissac committed Oct 01, 2019 20 belongs one of the folowing values: \code{"holm"},  Eric Coissac committed Aug 23, 2019 21 22 23 24 \code{"hochberg"}, \code{"hommel"}, \code{"bonferroni"}, \code{"BH"}, \code{"BY"}, \code{"fdr"}, \code{"none"}. The default is,set to \code{"holm"}.} }  Eric Coissac committed May 27, 2019 25 \description{  Eric Coissac committed Aug 23, 2019 26 27 performs a Monte-Carlo Test on the sum of the singular values of a procustean rotation (see \code{\link[ade4]{procuste.rtest}}).  Eric Coissac committed Oct 23, 2019 28 29 30 31 32 33 34 35 36 37 38 39 40 } \examples{ A <- simulate_matrix(10,3) B <- simulate_matrix(10,5) C <- simulate_correlation(B,10,r2=0.6) # Computes the correlation matrix data <- procmod_frame(A = A, B = B, C = C) corls_test(A, B, permutations = 100) corls_test(B, C, permutations = 100) corls_test(data, permutations = 100)  Eric Coissac committed Aug 23, 2019 41 42 43 44 45 } \references{ { \insertRef{Jackson:95:00}{ProcMod} }  Eric Coissac committed May 27, 2019 46 }  Eric Coissac committed Oct 01, 2019 47 48 49 \seealso{ \code{\link[stats]{p.adjust}} }  Eric Coissac committed May 27, 2019 50 51 52 53 54 \author{ Eric Coissac Christelle Gonindard-Melodelima }