ShinyWidgets 项目教程
1. 项目的目录结构及介绍
ShinyWidgets 项目的目录结构如下:
shinyWidgets/
├── DESCRIPTION
├── NAMESPACE
├── R/
│ ├── *.R
├── inst/
│ ├── doc/
│ ├── examples/
│ ├── htmlwidgets/
│ ├── shinyWidgets/
│ ├── www/
├── man/
│ ├── *.Rd
├── tests/
│ ├── testthat/
│ ├── testthat.R
├── vignettes/
│ ├── *.Rmd
├── LICENSE
├── README.md
├── NEWS.md
目录介绍
- DESCRIPTION: 项目描述文件,包含项目的元数据信息。
- NAMESPACE: 命名空间文件,定义了项目的导出和导入函数。
- R/: 包含项目的 R 代码文件。
- inst/: 包含项目的实例、示例、HTML 小部件、资源文件等。
- man/: 包含项目的帮助文档文件。
- tests/: 包含项目的测试代码。
- vignettes/: 包含项目的长格式文档,通常是教程或案例研究。
- LICENSE: 项目的许可文件。
- README.md: 项目的自述文件,通常包含项目的简介和使用说明。
- NEWS.md: 项目的更新日志文件。
2. 项目的启动文件介绍
ShinyWidgets 项目的启动文件通常是 app.R
或 server.R
和 ui.R
文件。这些文件定义了 Shiny 应用程序的用户界面和服务器逻辑。
示例启动文件
# app.R
library(shiny)
library(shinyWidgets)
ui <- fluidPage(
titlePanel("ShinyWidgets 示例"),
sidebarLayout(
sidebarPanel(
# 添加 ShinyWidgets 组件
switchInput(inputId = "somevalue", value = TRUE)
),
mainPanel(
textOutput("value")
)
)
)
server <- function(input, output) {
output$value <- renderText({ input$somevalue })
}
shinyApp(ui, server)
3. 项目的配置文件介绍
ShinyWidgets 项目的配置文件主要是 DESCRIPTION
文件,它包含了项目的元数据信息,如项目名称、版本、依赖关系等。
DESCRIPTION 文件示例
Package: shinyWidgets
Type: Package
Title: Custom Inputs Widgets for Shiny
Version: 0.8.6
Date: 2024-04-24
Authors@R: c(
person("Victor", "Perrier", role = c("aut", "cre", "cph"), email = "victor.perrier@dreamrs.fr"),
person("Fanny", "Meyer", role = c("aut")),
person("David", "Granjon", role = c("aut"))
)
Description: Collection of custom input controls and user interface components for 'Shiny' applications. Give your applications a unique and colorful style.
License: GPL-3
Depends: R (>= 3.1.0)
Imports: anytime, bslib, sass, shiny (>= 1.6.0), htmltools (>= 0.5.1), jsonlite, grDevices, rlang
Suggests: testthat, covr, ggplot2, DT, scales, shinydashboard, shinydashboardPlus
URL: https://github.com/dreamRs/shinyWidgets
BugReports: https://github.com/dreamRs/shinyWidgets/issues
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
配置文件介绍
- Package: 项目名称。
- Type: 项目类型,通常是
Package
。 - Title: 项目标题。
- Version: 项目版本号。
- Date: 项目发布日期。
- Authors@R: 项目作者信息。
- Description: 项目描述。
- License: 项目许可协议。
- Depends: 项目依赖的 R 版本。
- Imports: 项目导入的包。
- Suggests: 建议安装的包。
- URL: 项目主页或代码仓库地址。
- BugReports: