ggalluvial 开源项目教程
ggalluvialggplot2 extension for alluvial plots项目地址:https://gitcode.com/gh_mirrors/gg/ggalluvial
1. 项目的目录结构及介绍
ggalluvial 是一个用于创建和可视化多层级数据流的 R 包。以下是其主要目录结构和各部分的简要介绍:
ggalluvial/
├── DESCRIPTION
├── NAMESPACE
├── README.md
├── R/
│ ├── alluvial-data.R
│ ├── alluvial-ggproto.R
│ ├── alluvial-layer.R
│ ├── alluvial-stat.R
│ ├── geom-alluvial.R
│ ├── geom-alluvial-tile.R
│ ├── geom-stratum.R
│ ├── position-alluvial.R
│ └── utilities.R
├── data/
│ ├── full_data.rda
│ ├── sample_data.rda
│ └── test_data.rda
├── man/
│ ├── alluvial_data.Rd
│ ├── alluvial_ggproto.Rd
│ ├── alluvial_layer.Rd
│ ├── alluvial_stat.Rd
│ ├── geom_alluvial.Rd
│ ├── geom_alluvial_tile.Rd
│ ├── geom_stratum.Rd
│ ├── position_alluvial.Rd
│ └── utilities.Rd
├── tests/
│ ├── testthat.R
│ └── testthat/
│ ├── test-alluvial-data.R
│ ├── test-alluvial-ggproto.R
│ ├── test-alluvial-layer.R
│ ├── test-alluvial-stat.R
│ ├── test-geom-alluvial.R
│ ├── test-geom-alluvial-tile.R
│ ├── test-geom-stratum.R
│ ├── test-position-alluvial.R
│ └── test-utilities.R
└── vignettes/
└── ggalluvial.Rmd
- DESCRIPTION: 项目描述文件,包含包的元数据信息。
- NAMESPACE: 定义包的导出和导入函数。
- README.md: 项目说明文档,介绍项目的基本信息和使用方法。
- R/: 包含所有 R 脚本文件,定义包的主要功能和方法。
- data/: 包含示例数据和测试数据。
- man/: 包含函数的帮助文档。
- tests/: 包含测试脚本,用于确保包的正确性。
- vignettes/: 包含详细的示例和教程文档。
2. 项目的启动文件介绍
ggalluvial 项目的启动文件主要是 R/
目录下的各个 R 脚本文件。这些文件定义了包的核心功能和方法。例如:
alluvial-data.R
: 处理数据预处理的函数。alluvial-ggproto.R
: 定义 ggplot2 的 ggproto 对象。alluvial-layer.R
: 定义图层相关的函数。alluvial-stat.R
: 定义统计相关的函数。geom-alluvial.R
: 定义 alluvial 图的几何对象。geom-alluvial-tile.R
: 定义 alluvial 图的 tile 几何对象。geom-stratum.R
: 定义 stratum 几何对象。position-alluvial.R
: 定义位置调整相关的函数。utilities.R
: 包含一些辅助函数。
3. 项目的配置文件介绍
ggalluvial 项目的配置文件主要是 DESCRIPTION
和 NAMESPACE
文件。
- DESCRIPTION: 这个文件包含了包的元数据信息,如包的名称、版本、依赖关系等。例如:
Package: ggalluvial
Type: Package
Title: Alluvial Plots in 'ggplot2'
Version: 0.12.3
Date: 2021-01-01
Author: Cory Brunson
Maintainer: Cory Brunson <corybrunson@gmail.com>
Description: Create alluvial plots in 'ggplot2'.
License: GPL-3
Imports: ggplot2 (>= 3.3.0), dplyr
Suggests: testthat, knitr, rmarkdown
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
- NAMESPACE: 这个文件定义了包
ggalluvialggplot2 extension for alluvial plots项目地址:https://gitcode.com/gh_mirrors/gg/ggalluvial