Skip to content

Commit

Permalink
fix: small update to DESC, CRAN comments, GH actions
Browse files Browse the repository at this point in the history
  • Loading branch information
m-jahn committed Dec 12, 2023
1 parent fc85c18 commit 238f6c6
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 49 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [dev]
branches: [master, dev]
pull_request:
branches: [master, dev]
workflow_dispatch:
Expand Down
83 changes: 39 additions & 44 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,63 +1,58 @@
Package: WeightedTreemaps
Title: Generate and Plot Voronoi or Sunburst Treemaps from Hierarchical Data
Title: Generate and Plot Voronoi or Sunburst Treemaps from Hierarchical
Data
Version: 0.1.1
Authors@R: c(
person(given = "Michael",
family = "Jahn",
role = c("aut", "cre"),
email = "[email protected]",
person("Michael", "Jahn", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-3913-153X")),
person(given = "David",
family = "Leslie",
role = c("aut"),
email = "[email protected]"),
person(given = "Ahmadou",
family = "Dicko",
role = c("aut"),
email = "[email protected]",
person("David", "Leslie", , "[email protected]", role = "aut"),
person("Ahmadou", "Dicko", , "[email protected]", role = "aut",
comment = c(ORCID = "0000-0002-9654-7582")),
person(given = "Paul",
family = "Murrell",
role = c("aut", "cph"),
email = "[email protected]",
comment = c(ORCID = "0000-0002-3224-8858")))
Description: Treemaps are a visually appealing graphical representation of numerical data using a
space-filling approach. A plane or 'map' is subdivided into smaller areas called cells.
The cells in the map are scaled according to an underlying metric which allows to grasp the
hierarchical organization and relative importance of many objects at once. This package contains
two different implementations of treemaps, Voronoi treemaps and Sunburst treemaps.
The Voronoi treemap function subdivides the plot area in polygonal cells according to
the highest hierarchical level, then continues to subdivide those parental cells on the
next lower hierarchical level, and so on. The Sunburst treemap is a computationally less
demanding treemap that does not require iterative refinement, but simply generates
circle sectors that are sized according to predefined weights.
The Voronoi tesselation is based on functions from
Paul Murrell (2012) <https://www.stat.auckland.ac.nz/~paul/Reports/VoronoiTreemap/voronoiTreeMap.html>.
person("Paul", "Murrell", , "[email protected]", role = c("aut", "cph"),
comment = c(ORCID = "0000-0002-3224-8858"))
)
Description: Treemaps are a visually appealing graphical representation of
numerical data using a space-filling approach. A plane or 'map' is
subdivided into smaller areas called cells. The cells in the map are
scaled according to an underlying metric which allows to grasp the
hierarchical organization and relative importance of many objects at
once. This package contains two different implementations of treemaps,
Voronoi treemaps and Sunburst treemaps. The Voronoi treemap function
subdivides the plot area in polygonal cells according to the highest
hierarchical level, then continues to subdivide those parental cells
on the next lower hierarchical level, and so on. The Sunburst treemap
is a computationally less demanding treemap that does not require
iterative refinement, but simply generates circle sectors that are
sized according to predefined weights. The Voronoi tesselation is
based on functions from Paul Murrell (2012)
<https://www.stat.auckland.ac.nz/~paul/Reports/VoronoiTreemap/voronoiTreeMap.html>.
License: GPL-3
Depends: R (>= 3.5.0)
URL: https://github.com/m-jahn/WeightedTreemaps
BugReports: https://github.com/m-jahn/WeightedTreemaps/issues
Depends:
R (>= 3.5.0)
Imports:
colorspace,
dplyr,
grid,
lattice,
methods,
dplyr,
tibble,
sp,
sf,
Rcpp,
scales,
lattice,
colorspace,
Rcpp
sf,
sp,
tibble
Suggests:
parallel,
knitr,
parallel,
rmarkdown
LinkingTo:
BH,
Rcpp,
RcppCGAL,
BH
RcppCGAL
VignetteBuilder:
knitr
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.2.3
VignetteBuilder: knitr
SystemRequirements: C++17
URL: https://github.com/m-jahn/WeightedTreemaps
BugReports: https://github.com/m-jahn/WeightedTreemaps/issues
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
WeightedTreemaps
================
Michael Jahn, David Leslie, Ahmadou Dicko
2023-11-06
2023-12-12

<!-- include logo-->

Expand Down
9 changes: 6 additions & 3 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ now only printed when the user specifies verbose = TRUE.

- windows-latest (release)
- macOS-latest (release)
- ubuntu-20.04 (release)
- ubuntu-latest (devel)
- ubuntu-latest (release)
- ubuntu-latest (oldrel-1)


### with `rhub::check_for_cran()`

Expand All @@ -53,7 +56,7 @@ File ‘WeightedTreemaps/libs/WeightedTreemaps.so’:
of to the console, nor use Fortran I/O nor system RNGs.
```

The C++ function `voronoiDiagram.cpp` does not contain any such entry points. This Note is caused by the upstream dependency CGAL headers (R package `RcppCGAL`) or boost headers (`BH`). This note appears only when checking on Mac OS.
The C++ function `voronoiDiagram.cpp` does not contain any such entry points. This Note occasionally turns up on Mac OS tests, probably caused by the upstream dependency CGAL headers (R package `RcppCGAL`) or boost headers (`BH`).

2. Note:

Expand All @@ -65,7 +68,7 @@ checking installed package size ... NOTE
libs 7.7Mb
```

Installed package size exceeding 5 MB is mainly caused by the compiled function `voronoiDiagram.o`. The size of this file can not be reduced.
Installed package size exceeding 5 MB is caused by the compiled function `voronoiDiagram.o`. The size of this file can not be reduced.

## Downstream dependencies

Expand Down

0 comments on commit 238f6c6

Please sign in to comment.