diff --git a/R/ggVennDiagram.R b/R/ggVennDiagram.R index cfb124f..067d327 100644 --- a/R/ggVennDiagram.R +++ b/R/ggVennDiagram.R @@ -1,20 +1,5 @@ -#' shapes: shape data used to setup Venn plot -#' -#' a collection of geometric shapes, which defined the edge and label of sets in a Venn plot. -#' use `plot_shapes()` to see some of them. -#' -#' @format a list with several slots -#' see "?vennPlotData". -#' -#' @source -#' - `venn:::sets` -#' - `library(VennDiagram)` -#' - [Wiki](https://upload.wikimedia.org/wikipedia/commons/5/56/6-set_Venn_diagram_SMIL.svg) -#' @name vennplot-shapes -NULL - #' ggVennDiagram main parser #' #' @details diff --git a/R/plot_shapes.R b/R/plot_shapes.R index 1fc16d7..3fe877d 100644 --- a/R/plot_shapes.R +++ b/R/plot_shapes.R @@ -1,3 +1,20 @@ +#' shapes: shape data used to setup Venn plot +#' +#' a collection of geometric shapes, which defined the edge and label of sets in a Venn plot. +#' use `plot_shapes()` to see some of them. +#' +#' @format a list with several slots +#' see "?VennPlotData". +#' +#' @source +#' - `venn:::sets` +#' - `library("VennDiagram")` +#' - [Wiki](https://upload.wikimedia.org/wikipedia/commons/5/56/6-set_Venn_diagram_SMIL.svg) +#' @name vennplot-shapes +#' @docType data +#' @md +NULL + #' plot all shapes provided by internal dataset #' #' These shapes are mainly collected from the package `venn`, and `VennDiagram`. diff --git a/man/ggVennDiagram.Rd b/man/ggVennDiagram.Rd index 40390bd..0abd58c 100644 --- a/man/ggVennDiagram.Rd +++ b/man/ggVennDiagram.Rd @@ -52,7 +52,7 @@ ggVennDiagram( \item{edge_size}{line width of set edges (1)} -\item{force_upset}{if TRUE, will always produce Upset plot no matter how many sets have} +\item{force_upset}{if TRUE, will always produce Upset plot no matter how many sets have (FALSE)} \item{...}{useless} } diff --git a/man/vennplot-shapes.Rd b/man/vennplot-shapes.Rd index 3a568b4..82f2d2a 100644 --- a/man/vennplot-shapes.Rd +++ b/man/vennplot-shapes.Rd @@ -1,18 +1,21 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/ggVennDiagram.R +% Please edit documentation in R/plot_shapes.R +\docType{data} \name{vennplot-shapes} \alias{vennplot-shapes} \title{shapes: shape data used to setup Venn plot} \format{ a list with several slots - see "?vennPlotData". +see "?VennPlotData". } \source{ -- `venn:::sets` -- `library(VennDiagram)` -- [Wiki](https://upload.wikimedia.org/wikipedia/commons/5/56/6-set_Venn_diagram_SMIL.svg) +\itemize{ +\item \code{venn:::sets} +\item \code{library("VennDiagram")} +\item \href{https://upload.wikimedia.org/wikipedia/commons/5/56/6-set_Venn_diagram_SMIL.svg}{Wiki} +} } \description{ a collection of geometric shapes, which defined the edge and label of sets in a Venn plot. -use `plot_shapes()` to see some of them. +use \code{plot_shapes()} to see some of them. }