adjust shape doc

gaospecial · Dec 21, 2023 · 96c8149 · 96c8149
1 parent c77cafe
commit 96c8149
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 22 deletions.
diff --git 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
@@ -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
diff --git a/man/vennplot-shapes.Rd b/man/vennplot-shapes.Rd