MINI MINI MANI MO

%
% Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved. 
%
\name{ore.freq}
\alias{ore.freq}
\alias{ore.freq}
\title{Oracle R Enterprise Frequency Analysis}
\description{
  Operates on output from the function \code{\link{ore.crosstab}} and
  automatically determines techniques that are relevant for the
  table. For 1 way cross tables, goodness of fit tests for equal
  proportions or specific null proportions, confidence limits and tests
  are equivalence are supported. For 2 way cross tables, various
  statistics that describe relationships between columns involved in the
  cross tabulation are supported. This includes chi-square tests,
  cochran-mantel-haenzsel statistics, measures of association, strength
  of association, risk differences, odds ratio and relative risk for 2x2
  tables and tests for trend. N-way tables specifications are build as
  N, 2 way cross tables.
}
\usage{
  ore.freq(x, stats = NULL, params = NULL, persist = FALSE,
           skip.failed = FALSE, skip.missing = FALSE, use.ext = FALSE,
           use.r = FALSE, use.sql = FALSE) 
}
\arguments{
  \item{x}{Output from function \code{\link{ore.crosstab}}.}
  \item{stats}{A comma-separated character string specifying one or more
    of the following methods to use on argument \code{x}:
    Chi-Square Tests : \code{"AJCHI"}, \code{"LRCHI"}, \code{"MHCHI"},
                       \code{"PCHISQ"}
    Kappa Tests:    \code{"KAPPA"}, \code{"WTKAP"}
    Lambda Tests:   \code{"LAMCR"}, \code{"LAMRC"}, \code{"LAMDAS"}
    Correlation:    \code{"KENTB"}, \code{"PCORR"}, \code{"SCORR"}
    Stuart's Tau, Somer's D|C: \code{"STUTC"}, \code{"SMDCR"}, \code{"SMDRC"}
    Fisher's Test:  \code{"FISHER"}
    Cochran's Q:    \code{"COCHQ"}
    Odds Ratio:     \code{"OR"},    \code{"MHOR"},  \code{"LGOR"}
    Relative Risk:  \code{"RR"},    \code{"MHRR"},  \code{"ALRR"}
    Cramer's V:     \code{"CRAMV"}
    Gamma:          \code{"GAMMA"}
    Trend Test:     \code{"TREND"}
    McNemar's Test: \code{"MCNEM"}
  }
  \item{params}{
    A character string specifying the control parameters for the
    methods in argument \code{stats}. Possible setting include:
    Scoring Options: \code{"SCORE=TABLE|RANK|RIDIT|MODRIDIT"}
    Alpha criterion: \code{"ALPHA=<Number>"}
    Weights:         \code{"WEIGHTS=<Number>"}
  }
  \item{persist}{For internal use only.}
  \item{skip.failed}{A logical value indicating whether to return with
    an error if a particular statistical test fails or to skip over
    the in-applicable test.}
  \item{skip.missing}{A logical value indicating whether to skip cells
    with missing values in argument \code{x}.}
  \item{use.ext, use.r, use.sql}{For internal use only.}
}
\value{
  Returns an \code{\link[OREbase:ore.frame-class]{ore.frame}} object.
}
\references{
  \href{http://www.oracle.com/technetwork/database/database-technologies/r/r-enterprise/documentation/index.html}{Oracle R Enterprise}
}
\author{
  Oracle \email{oracle-r-enterprise@oracle.com}
}
\seealso{
  \code{\link{ore.crosstab}}
}
\examples{
\dontrun{
  IRIS <- ore.push(iris)
  x <- ore.crosstab(Species ~ Petal.Length + Sepal.Length, data = IRIS)
  ore.freq(x, stats = "SCORR, GAMMA, STUTC")
}
}
\keyword{category}