nhdplusTools/_pkgdown.yml at main · DOI-USGS/nhdplusTools · 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
url: https://doi-usgs.github.io/nhdplusTools/

reference:
  - title: Data Access
    desc: >
      Functions that help get access data. (all U.S. context)
  - contents:
      - '`get_3dhp`'
      - '`get_nhdphr`'
      - '`discover_geoconnex_reference`'
      - '`get_geoconnex_reference`'
      - '`download_nhdplushr`'
      - '`get_nhdplushr`'
      - '`get_hr_data`'
      - '`download_nhdplusv2`'
      - '`get_nhdplus`'
      - '`download_nhd`'
      - '`download_rf1`'
      - '`download_wbd`'
      - '`download_vaa`'
      - '`get_vaa`'
      - '`get_xs_point`'
      - '`get_xs_points`'
      - '`get_elev_along_path`'
      - '`rpu_boundaries`'
      - '`vpu_boundaries`'
      - '`get_boundaries`'
      - '`get_characteristics_metadata`'
      - '`get_catchment_characteristics`'
      - '`rescale_catchment_characteristics`'
      - '`get_drainage_area_estimates`'
  - title: Discovery and Subsetting
    desc: >
      Functions for finding and saving the part of the NHDPlus you are
      interested in working with. (All U.S. context)
  - contents:
      - '`subset_nhdplus`'
      - '`make_standalone`'
      - '`subset_rpu`'
      - '`subset_vpu`'
      - '`discover_nhdplus_id`'
      - '`get_gagesII`'
      - '`get_huc`'
      - '`get_nhdarea`'
      - '`get_waterbodies`'
      - '`get_nwis`'
      - '`get_nldi_basin`'
      - '`get_nldi_feature`'
      - '`get_split_catchment`'
      - '`get_raindrop_trace`'
  - title: Indexing and Network Navigation
    desc: >
      Functions to index and match data to NHDPlus features. Most of these
      work with any data that fits the expected data model. Some are very
      specific to the NHDPlus data model but are not specific to a U.S
      spatial context.
  - contents:
      - '`get_flowline_index`'
      - '`get_hydro_location`'
      - '`get_waterbody_index`'
      - '`get_wb_outlet`'
      - '`get_nldi_index`'
      - '`get_node`'
      - '`rescale_measures`'
      - '`disambiguate_flowline_indexes`'
      - '`get_partial_length`'
      - '`get_path_lengths`'
      - '`get_path_members`'
  - title: Network Navigation
    desc: >
      Functions to traverse and return network subsets. All except `navigate_nldi()`
      have applicability outside the U.S. context.
  - contents:
      - '`get_DD`'
      - '`get_DM`'
      - '`get_UM`'
      - '`get_UT`'
      - '`navigate_network`'
      - '`navigate_nldi`'
  - title: Package Helpers
    desc: >
      Functions that make the package easier to work with.
  - contents:
      - '`nhdplusTools_cache_settings`'
      - '`st_compatibalize`'
      - '`rename_geometry`'
      - '`align_nhdplus_names`'
      - '`nhdplus_path`'
      - '`nhdplusTools_data_dir`'
      - '`plot_nhdplus`'
      - '`map_nhdplus`'
      - '`prepare_nhdplus`'
      - '`get_vaa_names`'
      - '`get_vaa_path`'
      - '`rescale_catchment_characteristics`'
  - title: Network Attributes
    desc: >
      Functions that generate common river network attributes. These can be
      used with any data that adheres to the supported data model. See function
      documentation for specifics.
  - contents:
      - '`fix_flowdir`'
      - '`get_tocomid`'
      - '`make_node_topology`'
      - '`get_sorted`'
      - '`calculate_total_drainage_area`'
      - '`calculate_arbolate_sum`'
      - '`get_streamlevel`'
      - '`get_levelpaths`'
      - '`get_pathlength`'
      - '`get_streamorder`'
      - '`get_terminal`'
      - '`add_plus_network_attributes`'
      - '`get_pfaf`'

articles:
  - title: Vignettes
    contents:
      - nhdplusTools
      - get_data_overview
      - plot_nhdplus
      - indexing
      - nhdplushr
      - get_3dhp_data
      - drainage_area_estimation