% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RcppExports.R
\name{nVennDiagram}
\alias{nVennDiagram}
\title{Creates nVenn plot}
\usage{
nVennDiagram(
  desc,
  plot = TRUE,
  outFile = "",
  systemShow = FALSE,
  verbose = TRUE,
  maxlevel = 0L,
  byCol = 0L
)
}
\arguments{
\item{desc}{Description of sets, either as a file path, a list of lists, text or a
previously created nVenn object (see Details).}

\item{plot}{If true (default), the resulting diagram is plotted. If false,
only the object is returned.}

\item{outFile}{If it contains a valid file path and \code{plot} is also true,
the svg code of the plot will
be saved in that path.}

\item{systemShow}{If true, and \code{plot} is true, the function will attempt to
open the resulting
svg figure in the default editor. Defaults to false.}

\item{verbose}{If true, shows messages as the nVenn plot is created.}

\item{maxlevel}{If higher than zero, the simulation uses an exhaustive
algorithm for the minimization steps. The number will represent the
depth of the search. With a dept of one, every exchange of two regions
will be explored. With a depth of two, every exchange of four regions
will be explored. The computing resources necessary for this exploration
increase extremely fast with the depth, so users are advised to use
\code{\link[=estimateExhaustiveRunTime]{estimateExhaustiveRunTime()}} to determine whether it is feasible to use
this procedure. The process will be unresponsive during the simulation and
no messages will be shown,
regardless of \code{verbose}.}

\item{byCol}{If the input is a text, this parameter indicates whether
each set is a column (1) or a row (2). Defaults to 0, which means that
the package will try to guess which possibility makes more sense.}
}
\value{
nVenn object. As a side effect, shows the nVenn plot. In case of
error, returns null object.
}
\description{
Creates nVenn plot
}
\details{
A list of lists contains inner lists with a name, which will be
the corresponding set name. A dataframe can be used in the same way.

The input can also be a text containing a table, possibly with missing
values. If a text is provided, the package will try to guess if each set
is encoded in columns or rows (use \code{byCol} to force) and which
character separates fields (usually tab, space or comma). If the text
describes a valid text file path, the contents of the file will be used.
}
\examples{
myv <- nVennDiagram(list(Set1=c("a", "b", "c"), Set2=c("a", "c", "d")), verbose=FALSE)
}
