From 541d3c13467446c8e89b178d95b0984729559059 Mon Sep 17 00:00:00 2001 From: Barbara Borges Ribeiro Date: Thu, 23 Mar 2017 03:45:37 +0000 Subject: [PATCH] Update documentation to newest version of roxygen --- DESCRIPTION | 2 +- man/box.Rd | 1 - man/dashboardBody.Rd | 1 - man/dashboardHeader.Rd | 1 - man/dashboardPage.Rd | 1 - man/dashboardSidebar.Rd | 1 - man/dropdownMenu.Rd | 1 - man/dropdownMenuOutput.Rd | 1 - man/infoBox.Rd | 1 - man/menuItemOutput.Rd | 1 - man/menuOutput.Rd | 1 - man/messageItem.Rd | 1 - man/notificationItem.Rd | 1 - man/renderDropdownMenu.Rd | 1 - man/renderMenu.Rd | 1 - man/renderValueBox.Rd | 3 +-- man/shinydashboard.Rd | 1 - man/sidebarMenu.Rd | 3 +-- man/sidebarMenuOutput.Rd | 1 - man/sidebarSearchForm.Rd | 1 - man/sidebarUserPanel.Rd | 1 - man/tabBox.Rd | 1 - man/tabItem.Rd | 1 - man/tabItems.Rd | 1 - man/tagAssert.Rd | 1 - man/taskItem.Rd | 1 - man/updateTabItems.Rd | 1 - man/validColors.Rd | 1 - man/validStatuses.Rd | 1 - man/valueBox.Rd | 1 - man/valueBoxOutput.Rd | 3 +-- 31 files changed, 4 insertions(+), 34 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index e8780704..66d83901 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -18,4 +18,4 @@ Imports: shiny (>= 0.12.1), htmltools (>= 0.2.6) BugReports: https://github.com/rstudio/shinydashboard -RoxygenNote: 5.0.1 +RoxygenNote: 6.0.1 diff --git a/man/box.Rd b/man/box.Rd index 9626aaf0..d1a0b9f3 100644 --- a/man/box.Rd +++ b/man/box.Rd @@ -171,4 +171,3 @@ shinyApp( Other boxes: \code{\link{infoBox}}, \code{\link{tabBox}}, \code{\link{valueBox}} } - diff --git a/man/dashboardBody.Rd b/man/dashboardBody.Rd index 91162ecb..532e6461 100644 --- a/man/dashboardBody.Rd +++ b/man/dashboardBody.Rd @@ -16,4 +16,3 @@ pattern is for the main body to contain \code{\link{tabItems}}. \seealso{ \code{\link{tabItems}}, \code{\link{box}}, \code{\link{valueBox}}. } - diff --git a/man/dashboardHeader.Rd b/man/dashboardHeader.Rd index 02cf4bd0..c31a01cb 100644 --- a/man/dashboardHeader.Rd +++ b/man/dashboardHeader.Rd @@ -100,4 +100,3 @@ shinyApp( \seealso{ \code{\link{dropdownMenu}} } - diff --git a/man/dashboardPage.Rd b/man/dashboardPage.Rd index d8b8969a..2e29f3e0 100644 --- a/man/dashboardPage.Rd +++ b/man/dashboardPage.Rd @@ -43,4 +43,3 @@ shinyApp( \code{\link{dashboardHeader}}, \code{\link{dashboardSidebar}}, \code{\link{dashboardBody}}. } - diff --git a/man/dashboardSidebar.Rd b/man/dashboardSidebar.Rd index 4fcc1e6a..20aa54ed 100644 --- a/man/dashboardSidebar.Rd +++ b/man/dashboardSidebar.Rd @@ -72,4 +72,3 @@ shinyApp( \seealso{ \code{\link{sidebarMenu}} } - diff --git a/man/dropdownMenu.Rd b/man/dropdownMenu.Rd index 80ae66df..e11fad8f 100644 --- a/man/dropdownMenu.Rd +++ b/man/dropdownMenu.Rd @@ -35,4 +35,3 @@ Create a dropdown menu to place in a dashboard header \seealso{ \code{\link{dashboardHeader}} for example usage. } - diff --git a/man/dropdownMenuOutput.Rd b/man/dropdownMenuOutput.Rd index dfe460a9..a8cf541a 100644 --- a/man/dropdownMenuOutput.Rd +++ b/man/dropdownMenuOutput.Rd @@ -21,4 +21,3 @@ Other menu outputs: \code{\link{menuItemOutput}}, \code{\link{menuOutput}}, \code{\link{renderMenu}}, \code{\link{sidebarMenuOutput}} } - diff --git a/man/infoBox.Rd b/man/infoBox.Rd index e2695477..eb9aaf38 100644 --- a/man/infoBox.Rd +++ b/man/infoBox.Rd @@ -45,4 +45,3 @@ boxes are meant to be placed in the main body of a dashboard. Other boxes: \code{\link{box}}, \code{\link{tabBox}}, \code{\link{valueBox}} } - diff --git a/man/menuItemOutput.Rd b/man/menuItemOutput.Rd index b2bf5776..cd981ca6 100644 --- a/man/menuItemOutput.Rd +++ b/man/menuItemOutput.Rd @@ -21,4 +21,3 @@ Other menu outputs: \code{\link{dropdownMenuOutput}}, \code{\link{menuOutput}}, \code{\link{renderMenu}}, \code{\link{sidebarMenuOutput}} } - diff --git a/man/menuOutput.Rd b/man/menuOutput.Rd index ab37fa3e..4868a606 100644 --- a/man/menuOutput.Rd +++ b/man/menuOutput.Rd @@ -28,4 +28,3 @@ Other menu outputs: \code{\link{dropdownMenuOutput}}, \code{\link{menuItemOutput}}, \code{\link{renderMenu}}, \code{\link{sidebarMenuOutput}} } - diff --git a/man/messageItem.Rd b/man/messageItem.Rd index 4f049405..0a54071f 100644 --- a/man/messageItem.Rd +++ b/man/messageItem.Rd @@ -30,4 +30,3 @@ Create a message item to place in a dropdown message menu Other menu items: \code{\link{notificationItem}}, \code{\link{taskItem}} } - diff --git a/man/notificationItem.Rd b/man/notificationItem.Rd index 43f08b33..3095571f 100644 --- a/man/notificationItem.Rd +++ b/man/notificationItem.Rd @@ -26,4 +26,3 @@ Create a notification item to place in a dropdown notification menu Other menu items: \code{\link{messageItem}}, \code{\link{taskItem}} } - diff --git a/man/renderDropdownMenu.Rd b/man/renderDropdownMenu.Rd index d0212477..74737c6e 100644 --- a/man/renderDropdownMenu.Rd +++ b/man/renderDropdownMenu.Rd @@ -18,4 +18,3 @@ is useful if you want to save an expression in a variable.} \description{ This is the server-side function for creating a dynamic dropdown menu. } - diff --git a/man/renderMenu.Rd b/man/renderMenu.Rd index 98ace611..caef628e 100644 --- a/man/renderMenu.Rd +++ b/man/renderMenu.Rd @@ -102,4 +102,3 @@ Other menu outputs: \code{\link{dropdownMenuOutput}}, \code{\link{menuItemOutput}}, \code{\link{menuOutput}}, \code{\link{sidebarMenuOutput}} } - diff --git a/man/renderValueBox.Rd b/man/renderValueBox.Rd index c29ee10d..0eb5ab66 100644 --- a/man/renderValueBox.Rd +++ b/man/renderValueBox.Rd @@ -1,8 +1,8 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/valueBoxOutput.R \name{renderValueBox} -\alias{renderInfoBox} \alias{renderValueBox} +\alias{renderInfoBox} \title{Create an info or value box output (server side)} \usage{ renderValueBox(expr, env = parent.frame(), quoted = FALSE) @@ -62,4 +62,3 @@ shinyApp(ui, server) \seealso{ \code{\link{valueBoxOutput}} for the corresponding UI-side function. } - diff --git a/man/shinydashboard.Rd b/man/shinydashboard.Rd index 500fbf81..6fb3314e 100644 --- a/man/shinydashboard.Rd +++ b/man/shinydashboard.Rd @@ -8,4 +8,3 @@ \description{ shinydashboard } - diff --git a/man/sidebarMenu.Rd b/man/sidebarMenu.Rd index b7524ecf..1e04fa4e 100644 --- a/man/sidebarMenu.Rd +++ b/man/sidebarMenu.Rd @@ -1,9 +1,9 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/dashboardSidebar.R \name{sidebarMenu} +\alias{sidebarMenu} \alias{menuItem} \alias{menuSubItem} -\alias{sidebarMenu} \title{Create a dashboard sidebar menu and menu items.} \usage{ sidebarMenu(..., id = NULL, .list = NULL) @@ -82,4 +82,3 @@ colored oval containing text. Other sidebar items: \code{\link{sidebarSearchForm}}, \code{\link{sidebarUserPanel}} } - diff --git a/man/sidebarMenuOutput.Rd b/man/sidebarMenuOutput.Rd index 5bee9719..71b35f99 100644 --- a/man/sidebarMenuOutput.Rd +++ b/man/sidebarMenuOutput.Rd @@ -21,4 +21,3 @@ Other menu outputs: \code{\link{dropdownMenuOutput}}, \code{\link{menuItemOutput}}, \code{\link{menuOutput}}, \code{\link{renderMenu}} } - diff --git a/man/sidebarSearchForm.Rd b/man/sidebarSearchForm.Rd index 7e9019de..0231f7b1 100644 --- a/man/sidebarSearchForm.Rd +++ b/man/sidebarSearchForm.Rd @@ -26,4 +26,3 @@ A search form consists of a text input field and a search button. Other sidebar items: \code{\link{sidebarMenu}}, \code{\link{sidebarUserPanel}} } - diff --git a/man/sidebarUserPanel.Rd b/man/sidebarUserPanel.Rd index dd98349d..13c2f5aa 100644 --- a/man/sidebarUserPanel.Rd +++ b/man/sidebarUserPanel.Rd @@ -24,4 +24,3 @@ A panel displaying user information in a sidebar Other sidebar items: \code{\link{sidebarMenu}}, \code{\link{sidebarSearchForm}} } - diff --git a/man/tabBox.Rd b/man/tabBox.Rd index 853efc71..eae27eed 100644 --- a/man/tabBox.Rd +++ b/man/tabBox.Rd @@ -87,4 +87,3 @@ shinyApp( Other boxes: \code{\link{box}}, \code{\link{infoBox}}, \code{\link{valueBox}} } - diff --git a/man/tabItem.Rd b/man/tabItem.Rd index b3d423db..e7bcada1 100644 --- a/man/tabItem.Rd +++ b/man/tabItem.Rd @@ -19,4 +19,3 @@ One tab to put inside a tab items container \code{\link{menuItem}}, \code{\link{menuSubItem}}, \code{\link{tabItems}}. See \code{\link{sidebarMenu}} for a usage example. } - diff --git a/man/tabItems.Rd b/man/tabItems.Rd index 42924995..0b2fe4dc 100644 --- a/man/tabItems.Rd +++ b/man/tabItems.Rd @@ -17,4 +17,3 @@ A container for tab items \code{\link{menuItem}}, \code{\link{menuSubItem}}, \code{\link{tabItem}}. See \code{\link{sidebarMenu}} for a usage example. } - diff --git a/man/tagAssert.Rd b/man/tagAssert.Rd index 93f94c82..14b55bef 100644 --- a/man/tagAssert.Rd +++ b/man/tagAssert.Rd @@ -22,4 +22,3 @@ contents.} Assert that a tag has specified properties } \keyword{internal} - diff --git a/man/taskItem.Rd b/man/taskItem.Rd index 477ef11b..c4a78b72 100644 --- a/man/taskItem.Rd +++ b/man/taskItem.Rd @@ -25,4 +25,3 @@ Create a task item to place in a dropdown task menu Other menu items: \code{\link{messageItem}}, \code{\link{notificationItem}} } - diff --git a/man/updateTabItems.Rd b/man/updateTabItems.Rd index 555e84d6..c264fa55 100644 --- a/man/updateTabItems.Rd +++ b/man/updateTabItems.Rd @@ -58,4 +58,3 @@ server <- function(input, output, session) { shinyApp(ui, server) } } - diff --git a/man/validColors.Rd b/man/validColors.Rd index f4e69ba3..2bb839b8 100644 --- a/man/validColors.Rd +++ b/man/validColors.Rd @@ -28,4 +28,3 @@ listed below. } } \keyword{internal} - diff --git a/man/validStatuses.Rd b/man/validStatuses.Rd index 60760c80..011cae18 100644 --- a/man/validStatuses.Rd +++ b/man/validStatuses.Rd @@ -19,4 +19,3 @@ generally appear as follows: } } \keyword{internal} - diff --git a/man/valueBox.Rd b/man/valueBox.Rd index a79faf03..d8ca53b2 100644 --- a/man/valueBox.Rd +++ b/man/valueBox.Rd @@ -36,4 +36,3 @@ to be placed in the main body of a dashboard. Other boxes: \code{\link{box}}, \code{\link{infoBox}}, \code{\link{tabBox}} } - diff --git a/man/valueBoxOutput.Rd b/man/valueBoxOutput.Rd index efada325..6f8e56ba 100644 --- a/man/valueBoxOutput.Rd +++ b/man/valueBoxOutput.Rd @@ -1,8 +1,8 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/valueBoxOutput.R \name{valueBoxOutput} -\alias{infoBoxOutput} \alias{valueBoxOutput} +\alias{infoBoxOutput} \title{Create an info or value box output (client side)} \usage{ valueBoxOutput(outputId, width = 4) @@ -26,4 +26,3 @@ This is the UI-side function for creating a dynamic \code{\link{valueBox}} or \code{\link{renderValueBox}} for the corresponding server-side function and examples. } -