File: r2describe.Rd

package info (click to toggle)
hmisc 5.2-4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,044 kB
  • sloc: asm: 28,905; f90: 590; ansic: 415; xml: 160; fortran: 75; makefile: 2
file content (31 lines) | stat: -rw-r--r-- 806 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/r2describe.r
\name{r2describe}
\alias{r2describe}
\title{r2describe}
\usage{
r2describe(x, nvmax = 10)
}
\arguments{
\item{x}{numeric matrix with 2 or more columns}

\item{nvmax}{maxmum number of columns of x to use in predicting a given column}
}
\value{
nothing
}
\description{
Summarize Strength of Relationships Using R-Squared From Linear Regression
}
\details{
Function to use \code{leaps::regsubsets()} to briefly describe which variables more strongly predict another variable.  Variables are in a numeric matrix and are assumed to be transformed so that relationships are linear (e.g., using \code{redun()} or \code{transcan()}.)
}
\examples{
\dontrun{
r <- redun(...)
r2describe(r$scores)
}
}
\author{
Frank Harrell
}