docs: initial readme documentation

Author: daniloimparato

R/easylayout-package.R

@@ -1,4 +1,4 @@
-#' easylayout: Publication-ready Networks Directly in your IDE
+#' easylayout: Publication-Ready Networks Directly in your IDE
 #'
 #' The `easylayout` package seamlessly bridges manipulation and visualization
 #' by leveraging the user’s IDE itself (e.g., RStudio, VSCode). It is not yet

README.Rmd

@@ -0,0 +1,68 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# easylayout: Publication-Ready Networks Directly in your IDE
+
+<!-- badges: start -->
+[![R-CMD-check](https://github.com/dalmolingroup/easylayout/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dalmolingroup/easylayout/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
+
+Easylayout is an R package that 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.
+
+## Installation
+
+You can install the development version of easylayout from [GitHub](https://github.com/) with:
+
+```r
+# install.packages("devtools")
+devtools::install_github("daniloimparato/easylayout", ref = "main")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r example, eval = FALSE}
+library(easylayout)
+library(igraph)
+
+g <- igraph::erdos.renyi.game(n = 5000, p.or.m = 10000, type = "gnm")
+
+number_of_vertices <- igraph::vcount(g)
+
+igraph::V(g)$label <- NA
+igraph::V(g)$size <- sample(1:5, number_of_vertices, replace = TRUE)
+igraph::V(g)$color <- sample(rainbow(5), number_of_vertices, replace = TRUE)
+
+plot(g, layout = easylayout)
+```
+
+## Future work
+
+The current implementation focuses on the R ecosystem, but using web
+technologies makes it easily portable to similar environments, like Jupyter
+Notebooks. We expect this tool to reduce the time spent tweaking network
+layouts, allowing researches to generate more compelling figures.

README.md

@@ -1 +1,60 @@
-# easylayout
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# easylayout: Publication-Ready Networks Directly in your IDE
+
+<!-- badges: start -->
+
+[![R-CMD-check](https://github.com/dalmolingroup/easylayout/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dalmolingroup/easylayout/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
+
+Easylayout is an R package that 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.
+
+## Installation
+
+You can install the development version of easylayout from
+[GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("daniloimparato/easylayout", ref = "main")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+library(easylayout)
+library(igraph)
+
+g <- igraph::erdos.renyi.game(n = 5000, p.or.m = 10000, type = "gnm")
+
+number_of_vertices <- igraph::vcount(g)
+
+igraph::V(g)$label <- NA
+igraph::V(g)$size <- sample(1:5, number_of_vertices, replace = TRUE)
+igraph::V(g)$color <- sample(rainbow(5), number_of_vertices, replace = TRUE)
+
+plot(g, layout = easylayout)
+```
+
+## Future work
+
+The current implementation focuses on the R ecosystem, but using web
+technologies makes it easily portable to similar environments, like
+Jupyter Notebooks. We expect this tool to reduce the time spent tweaking
+network layouts, allowing researches to generate more compelling
+figures.