[Vennerable-commits] r42 - pkg/Vennerable/man

[noreply at r-forge.r-project.org]

Author: js229
Date: 2009-08-04 19:28:26 +0200 (Tue, 04 Aug 2009)
New Revision: 42

Added:
   pkg/Vennerable/man/PlotDarkMatter.Rd
Log:
add documentation

Added: pkg/Vennerable/man/PlotDarkMatter.Rd
===================================================================
--- pkg/Vennerable/man/PlotDarkMatter.Rd	                        (rev 0)
+++ pkg/Vennerable/man/PlotDarkMatter.Rd	2009-08-04 17:28:26 UTC (rev 42)
@@ -0,0 +1,34 @@
+\name{PlotDarkMatter}
+\Rdversion{1.1}
+\alias{PlotDarkMatter}
+\title{
+Plots dark matter
+}
+\description{
+Fills the area of a \code{VennDrawing} universe that is not occupied by any set.
+}
+\usage{
+PlotDarkMatter(VD)
+}
+\arguments{
+  \item{VD}{
+An object of class \code{VennDrawing}
+}
+}
+\details{
+This works by filling the entire universe with grey (not currently changeable) and then plotting
+then filling the inside of the dark matter boundary with white.
+}
+\value{
+Executed for its side effecrs
+}
+\author{
+Jonathan Swinton (jonathan at swintons.net)
+}
+\examples{
+VD <- compute.Venn(Venn(n=2))
+PlotDarkMatter(VD)
+}
+% Add one or more standard keywords, see file 'KEYWORDS' in the
+% R documentation directory.
+\keyword{ graphs }