library(htmltools)

box <- function(title, text, link, class = "info", width = 4){
  div(
    class = sprintf("col-sm-%s", width),
    tags$a(
      href = sprintf("%s.html", link),
      class = "docs-link",
      div(
        class = sprintf("panel panel-%s", class),
        div(
          class = "panel-heading",
          title
        ),
        div(
          class = "panel-body centerize",
          text
        )
      )
    )
  )
}

row <- function(...){
  div(
    class = "row",
    ...
  )
}

Quick Start

row(
  box(
    "Get Started",
    "A quick guide to get started with g2r",
    "get-started",
    class = "orange"
  ),
  box(
    "Installation",
    "How to install the package",
    "installation"
  ),
  box(
    "Quick Plots",
    "Convenient function to quickly draw plots",
    "quick"
  )
)

Figures

row(
  box(
    "Figures",
    "Browse based figures available",
    "figures",
    class = "orange"
  ),
  box(
    "Graph",
    "How to draw networks with g2r",
    "graph"
  ),
  box(
    "Maps",
    "Draw maps with g2r",
    "map"
  )
)
row(
  box(
    "Recipes",
    "Common patterns to draw plots with g2r",
    "recipes",
    width = 6
  ),
  box(
    "Advanced",
    "Short vignettes detailing some of the inner-workings of the package",
    "advanced",
    width = 6
  )
)

Customise

row(
  box(
    "Aspects",
    "How to define aspects of a visualisation",
    "aspects",
    class = "orange"
  ),
  box(
    "Tooltip",
    "Customise the tooltip",
    "tooltip"
  ),
  box(
    "Adjust",
    "Learn about the adjust function",
    "adjust"
  )
)
row(
  box(
    "Axis",
    "How to handle axes",
    "axis"
  ),
  box(
    "Gauges",
    "Learn about gauges to scales aspects of plots",
    "gauges"
  ),
  box(
    "Info",
    "How to draw informational annotations",
    "info"
  )
)

Layout

row(
  box(
    "Planes",
    "How to facet the plot",
    "planes",
    width = 6
  ),
  box(
    "Motif",
    "How to customise the theme of visualisations",
    "motif",
    width = 6
  )
)

Interactions

row(
  box(
    "Animations",
    "How to customise animations",
    "animations",
    width = 6
  ),
  box(
    "Interplay",
    "Customise interactions and state",
    "interplay-state",
    width = 6
  )
)

Integrations

row(
  box(
    "Crosstalk",
    "Linking g2r visualisations with other widgets",
    "crosstalk"
  ),
  box(
    "Shiny",
    "How to use g2r with shiny",
    "shiny"
  ),
  box(
    "Rmarkdown",
    "Integration of g2r with rmarkdown",
    "actions"
  )
)


devOpifex/g2r documentation built on Jan. 16, 2022, 12:36 a.m.