hexify/_pkgdown.yml at main · gcol33/hexify · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
url: https://gcol33.github.io/hexify/
template:
  bootstrap: 5
  bootswatch: sandstone
  light-switch: yes
  # MathJax: not needed (no LaTeX math in vignettes)
figures:
  dev: svglite::svglite
  fig.ext: svg
  bg: '#F5F6F8'
navbar:
  structure:
    left:
    - intro
    - reference
    - articles
    right:
    - search
    - github
    - lightswitch
  components:
    articles:
      text: Articles
      menu:
      - text: Quick Start
        href: articles/quickstart.html
      - text: Workflows
        href: articles/workflows.html
      - text: Visualization
        href: articles/visualization.html
      - text: H3 Grids
        href: articles/h3.html
    github:
      icon: fab fa-github
      href: https://github.com/gcol33/hexify
      aria-label: GitHub
articles:
- title: Getting Started
  contents: quickstart
- title: Guides
  contents:
  - workflows
  - visualization
  - h3
reference:
- title: Core
  desc: Create grids and assign points to cells
  contents:
  - hex_grid
  - hexify
  - hexify_assign
  - HexGridInfo-class
  - HexData-class
- title: Working with Results
  desc: Extract and convert HexData
  contents:
  - grid_info
  - cells
  - n_cells
  - as_sf
  - as_tibble.HexData
  - is_hex_grid
  - is_hex_data
- title: Grid Generation
  desc: Create grids over regions
  contents:
  - grid_rect
  - grid_global
  - grid_clip
  - cell_to_sf
  - lonlat_to_cell
  - cell_to_lonlat
  - get_parent
  - get_children
- title: H3 Interoperability
  desc: Cross-grid mapping and per-cell area
  contents:
  - h3_crosswalk
  - cell_area
- title: Visualization
  desc: Plotting functions
  contents:
  - hexify_heatmap
  - plot_grid
  - plot_world
  - plot_globe
  - hexify_world
  - globe_centers
  - starts_with("plot,HexData")
- title: dggridR Compatibility
  desc: Interoperability with dggridR
  contents:
  - as_dggrid
  - from_dggrid
  - dggrid_is_compatible
  - dggrid_43h_sequence
  - hexify_grid
  - dgearthstat
  - dgverify
  - hexify_compare_resolutions
- title: Low-Level API
  desc: Direct access to projection and coordinate transforms
  contents:
  - starts_with("hexify_lonlat")
  - starts_with("hexify_cell")
  - starts_with("hexify_quad")
  - starts_with("hexify_icosa")
  - starts_with("hexify_index")
  - hexify_forward
  - hexify_forward_to_face
  - hexify_inverse
  - hexify_which_face
  - hexify_build_icosa
  - hexify_face_centers
  - hexify_grid_rect
  - hexify_grid_global
  - hexify_grid_to_cell
  - hexify_grid_cell_to_lonlat
  - hex_corners_to_sf
  - hexify_projection_stats
  - dg_closest_res_to_area
  - hexify_area_to_eff_res
  - hexify_eff_res_to_area
  - hexify_eff_res_to_resolution
  - hexify_resolution_to_eff_res
  - hexify_compare_indices
  - hexify_default_index_type
  - hexify_is_valid_index_type
  - cell_to_index
  - hexify_get_children
  - hexify_get_parent
  - hexify_get_precision
  - hexify_get_resolution
  - hexify_set_precision
  - hexify_z7_canonical
  - hexify_roundtrip_test
  - hexify_set_verbose
- title: Internal
  desc: Package internals
  contents:
  - hexify-package
  - hexify-conversions
  - hexify-grid
  - hexify-stats
  - HexGridInfo-methods
  - HexData-methods
  - new_hex_data
  - extract_grid
  - index_to_cell_internal
  - calculate_resolution_for_area
  - hexify_grid_to_HexGridInfo
  - HexGridInfo_to_hexify_grid