File: comparedf.Rd

package info (click to toggle)
r-cran-arsenal 3.6.3-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,788 kB
  • sloc: sh: 18; makefile: 5
file content (45 lines) | stat: -rw-r--r-- 1,630 bytes parent folder | download | duplicates (3)
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
39
40
41
42
43
44
45
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/comparedf.R
\name{comparedf}
\alias{comparedf}
\alias{print.comparedf}
\title{Compare two data.frames and report differences}
\usage{
comparedf(x, y, by = NULL, by.x = by, by.y = by, control = NULL, ...)

\method{print}{comparedf}(x, ...)
}
\arguments{
\item{x, y}{A data.frame to compare}

\item{by, by.x, by.y}{Which variables are IDs to merge the two data.frames?
If set to \code{"row.names"}, merging will occur over the row.names.
If set to \code{NULL} (default), merging will occur row-by-row.}

\item{control}{A list of control parameters from \code{\link{comparedf.control}}.}

\item{...}{Other arguments, passed to \code{\link{comparedf.control}} when appropriate.}
}
\description{
Compare two data.frames and report any differences between them,
 much like SAS's \code{PROC COMPARE} procedure.
}
\examples{

df1 <- data.frame(id = paste0("person", 1:3), a = c("a", "b", "c"),
                  b = c(1, 3, 4), c = c("f", "e", "d"),
                  row.names = paste0("rn", 1:3), stringsAsFactors = FALSE)
df2 <- data.frame(id = paste0("person", 3:1), a = c("c", "b", "a"),
                  b = c(1, 3, 4), d = paste0("rn", 1:3),
                  row.names = paste0("rn", c(1,3,2)), stringsAsFactors = FALSE)
summary(comparedf(df1, df2))
summary(comparedf(df1, df2, by = "id"))
summary(comparedf(df1, df2, by = "row.names"))
}
\seealso{
\code{\link{summary.comparedf}}, \code{\link{comparedf.control}},
  \code{\link{diffs}}, \code{\link{n.diffs}}, \code{\link{n.diff.obs}}
}
\author{
Ethan Heinzen, adapted from code from Andrew Hanson
}