From a9b8d4f15039ad63362f2ecbaa0b4a1f052dbd00 Mon Sep 17 00:00:00 2001
From: jvfe <jvfecav@gmail.com>
Date: Tue, 1 Oct 2024 20:42:27 -0300
Subject: [PATCH] fix: Separate function and package doc

If this is not done, the reference index breaks and pkgdown can't find
the package's functions (in this case, function).
---
 R/easylayout-package.R    |  2 +-
 man/easylayout-package.Rd | 33 +++++++++++++++++++++++++++++++++
 man/easylayout.Rd         | 23 +----------------------
 3 files changed, 35 insertions(+), 23 deletions(-)
 create mode 100644 man/easylayout-package.Rd

diff --git a/R/easylayout-package.R b/R/easylayout-package.R
index 5444c7d..c74d9ed 100644
--- a/R/easylayout-package.R
+++ b/R/easylayout-package.R
@@ -15,7 +15,7 @@
 #' itself.
 #'
 #' @docType package
-#' @name easylayout
+#' @name easylayout-package
 #' @keywords internal
 "_PACKAGE"
 
diff --git a/man/easylayout-package.Rd b/man/easylayout-package.Rd
new file mode 100644
index 0000000..06e21c2
--- /dev/null
+++ b/man/easylayout-package.Rd
@@ -0,0 +1,33 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/easylayout-package.R
+\docType{package}
+\name{easylayout-package}
+\alias{easylayout-package}
+\title{easylayout: Publication-Ready Networks Directly in your IDE}
+\description{
+The \code{easylayout} package seamlessly bridges manipulation and visualization
+by leveraging the user’s IDE itself (e.g., RStudio, VSCode). It is not yet
+another visualization library, but instead aims to interconnect existing
+libraries and streamline their usage into the R ecosystem. Easylayout takes
+an igraph object and serializes it into a web application integrated with
+the IDE’s interface through a Shiny server. The web application lays out the
+network by simulating attraction and repulsion forces. Simulation parameters
+can be adjusted in real-time. An editing mode allows moving and rotating
+nodes. The implementation aims for performance, so that even lower-end
+devices are able to work with relatively large networks. Once the user
+finishes tinkering the layout, it is sent back to the R session to be
+plotted through popular libraries like ggplot2 or even the base package
+itself.
+}
+\seealso{
+Useful links:
+\itemize{
+  \item \url{https://dalmolingroup.github.io/easylayout/}
+}
+
+}
+\author{
+\strong{Maintainer}: Danilo Imparato \email{first.last@example.com} (\href{https://orcid.org/0000-0001-6979-4951}{ORCID})
+
+}
+\keyword{internal}
diff --git a/man/easylayout.Rd b/man/easylayout.Rd
index f240618..eed7a2b 100644
--- a/man/easylayout.Rd
+++ b/man/easylayout.Rd
@@ -1,8 +1,6 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/app.R, R/easylayout-package.R
-\docType{package}
+% Please edit documentation in R/app.R
 \name{easylayout}
-\alias{easylayout-package}
 \alias{easylayout}
 \title{Layout an igraph object using easylayout's web application.}
 \usage{
@@ -24,20 +22,6 @@ can be adjusted in real-time. An editing mode allows moving and rotating
 nodes. Once the user finishes tinkering the layout, it is sent back to the
 R session to be plotted through popular libraries like ggplot2 or even the
 base package itself.
-
-The \code{easylayout} package seamlessly bridges manipulation and visualization
-by leveraging the user’s IDE itself (e.g., RStudio, VSCode). It is not yet
-another visualization library, but instead aims to interconnect existing
-libraries and streamline their usage into the R ecosystem. Easylayout takes
-an igraph object and serializes it into a web application integrated with
-the IDE’s interface through a Shiny server. The web application lays out the
-network by simulating attraction and repulsion forces. Simulation parameters
-can be adjusted in real-time. An editing mode allows moving and rotating
-nodes. The implementation aims for performance, so that even lower-end
-devices are able to work with relatively large networks. Once the user
-finishes tinkering the layout, it is sent back to the R session to be
-plotted through popular libraries like ggplot2 or even the base package
-itself.
 }
 \examples{
 \dontrun{
@@ -47,8 +31,3 @@ g <- easylayout(g)
 plot(g)
 }
 }
-\author{
-\strong{Maintainer}: First Last \email{first.last@example.com} (\href{https://orcid.org/YOUR-ORCID-ID}{ORCID})
-
-}
-\keyword{internal}