R/help.R

In jimbrig2011/arsenal: Useful tools to arm R developers

#' arsenal help
#'
#' @return a taglist
#' @noRd
#' @importFrom htmltools includeMarkdown tags tagList
#' @importFrom shiny tabsetPanel tabPanel icon HTML
helpModal <- function() {

  tagList(
    tabsetPanel(

      tabPanel(
        title = "Welcome",

        tags$h3("Welcome !"),
        tags$br(),
        tags$p("Simplify your project's and shiny application setup with ", tags$b("arsenal"), " !"),
        tags$br(),
        tags$ol(
          tags$li("Create a project within RStudio"),
          tags$li("Launch arsenal in the Addins menu"),
          tags$li("Structure your project by creating some directories"),
          tags$li("Initialize a template for a simple script or a Shiny application"),
          tags$li("Enjoy & start coding !")
        ),
        tags$br(),
        tags$br(),
        tags$p(
          "More information on :",
          tags$a(icon("github"), href = "https://github.com/jimbrig2011/arsenal")
        ),
        tags$p(
          "If you have questions, you can ask them here :",
          tags$a(
            "https://github.com/jimbrig2011/arsenal/issues",
            href = "https://github.com/jimbrig2011/arsenal/issues"
          )
        ),
        tags$br(),
        tags$br(),
        tags$p(
          "Keep Calm and use", tags$b("arsenal") , "!"
        )
      ),

      tabPanel(
        title = "Configuration",
        tags$br(),
        tags$p(
          "You can customize a lot of options in addinit, for example the names",
          "of the directories to create or a default author for the scripts.",
          "For this just modify the parameters list below and",
          "set the option arsenal in your .Rprofile."
        ),
        tags$div(style = "max-height: 300px;overflow-y: scroll;",
                 includeMarkdown(path = system.file('www/params.md', package = 'arsenal')))
      )

    ),
    tags$script(HTML("$('ul.nav-tabs').addClass('nav-justified');"))
  )

}