ggalluvial 开源项目教程

随笔3个月前发布 赵军
43 0 0

ggalluvial 开源项目教程

ggalluvialggplot2 extension for alluvial plots项目地址:https://gitcode.com/gh_mirrors/gg/ggalluvial

1. 项目的目录结构及介绍

ggalluvial 是一个用于创建和可视化多层级数据流的 R 包。以下是其主要目录结构和各部分的简要介绍:

  1. ggalluvial/

  2. ├── DESCRIPTION

  3. ├── NAMESPACE

  4. ├── README.md

  5. ├── R/

  6. │ ├── alluvial-data.R

  7. │ ├── alluvial-ggproto.R

  8. │ ├── alluvial-layer.R

  9. │ ├── alluvial-stat.R

  10. │ ├── geom-alluvial.R

  11. │ ├── geom-alluvial-tile.R

  12. │ ├── geom-stratum.R

  13. │ ├── position-alluvial.R

  14. │ └── utilities.R

  15. ├── data/

  16. │ ├── full_data.rda

  17. │ ├── sample_data.rda

  18. │ └── test_data.rda

  19. ├── man/

  20. │ ├── alluvial_data.Rd

  21. │ ├── alluvial_ggproto.Rd

  22. │ ├── alluvial_layer.Rd

  23. │ ├── alluvial_stat.Rd

  24. │ ├── geom_alluvial.Rd

  25. │ ├── geom_alluvial_tile.Rd

  26. │ ├── geom_stratum.Rd

  27. │ ├── position_alluvial.Rd

  28. │ └── utilities.Rd

  29. ├── tests/

  30. │ ├── testthat.R

  31. │ └── testthat/

  32. │ ├── test-alluvial-data.R

  33. │ ├── test-alluvial-ggproto.R

  34. │ ├── test-alluvial-layer.R

  35. │ ├── test-alluvial-stat.R

  36. │ ├── test-geom-alluvial.R

  37. │ ├── test-geom-alluvial-tile.R

  38. │ ├── test-geom-stratum.R

  39. │ ├── test-position-alluvial.R

  40. │ └── test-utilities.R

  41. └── vignettes/

  42. └── 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 项目的配置文件主要是 DESCRIPTIONNAMESPACE 文件。

  • DESCRIPTION: 这个文件包含了包的元数据信息,如包的名称、版本、依赖关系等。例如:
  1. Package: ggalluvial

  2. Type: Package

  3. Title: Alluvial Plots in 'ggplot2'

  4. Version: 0.12.3

  5. Date: 2021-01-01

  6. Author: Cory Brunson

  7. Maintainer: Cory Brunson <corybrunson@gmail.com>

  8. Description: Create alluvial plots in 'ggplot2'.

  9. License: GPL-3

  10. Imports: ggplot2 (>= 3.3.0), dplyr

  11. Suggests: testthat, knitr, rmarkdown

  12. Encoding: UTF-8

  13. LazyData: true

  14. RoxygenNote: 7.1.1

  • NAMESPACE: 这个文件定义了包

ggalluvialggplot2 extension for alluvial plots项目地址:https://gitcode.com/gh_mirrors/gg/ggalluvial

© 版权声明

相关文章

暂无评论

您必须登录才能参与评论!
立即登录
暂无评论...