forked from tidyverse/dplyr
-
Notifications
You must be signed in to change notification settings - Fork 0
/
all.equal.data.frame.Rd
39 lines (32 loc) · 1.25 KB
/
all.equal.data.frame.Rd
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
32
33
34
35
36
37
38
% Generated by roxygen2 (4.0.0): do not edit by hand
\name{all.equal.data.frame}
\alias{all.equal.data.frame}
\title{Provide a useful implementation of all.equal for data.frames.}
\usage{
\method{all.equal}{data.frame}(target, current, ignore_col_order = TRUE,
ignore_row_order = TRUE, convert = FALSE, ...)
}
\arguments{
\item{target,current}{two data frames to compare}
\item{ignore_col_order}{should order of columns be ignored?}
\item{ignore_row_order}{should order of rows be ignored?}
\item{convert}{Should similar classes be converted? Currently this will
convert factor to character and integer to double.}
\item{...}{Ignored. Needed for compatibility with the generic.}
}
\value{
\code{TRUE} if equal, otherwise a character vector describing
the first reason why they're not equal. Use \code{\link{isTRUE}} if
using the result in an \code{if} expression.
}
\description{
Provide a useful implementation of all.equal for data.frames.
}
\examples{
scramble <- function(x) x[sample(nrow(x)), sample(ncol(x))]
# By default, ordering of rows and columns ignored
all.equal(mtcars, scramble(mtcars))
# But those can be overriden if desired
all.equal(mtcars, scramble(mtcars), ignore_col_order = FALSE)
all.equal(mtcars, scramble(mtcars), ignore_row_order = FALSE)
}