flownet/_pkgdown.yml at master · SebKrantz/flownet · 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
url: https://sebkrantz.github.io/flownet/

home:
  title: Transport Modeling in R

template:
  bootstrap: 5
  bootswatch: sandstone # Also good: flatly, yeti, simplex, superhero, zephyr
  theme: ayu-dark # Or: ayu-mirage
  math-rendering: katex
  bslib:
    primary: "#1e2124" # "#202224" # "#242424" # "#003254"
    code-color: "#004573" # "#9c0027" # "#004d80" # b3002d
    gray-dark: "#3f464d"

development:
  mode: auto

navbar:
  title: flownet
  structure:
    left:
    - reference
    - articles
    - news
    - blog
    right:
    - search
    - github
  components:
    reference:
      text: Documentation
      href: reference/index.html
    articles:
      text: Vignettes
      href: articles/index.html
    news:
      text: News
      href: news/index.html
    blog:
      text: Blog
      href: https://sebkrantz.github.io/Rblog/
    github:
      icon: fa-github
      href: https://github.com/SebKrantz/flownet
      aria-label: GitHub


reference:
- contents:
  - flownet-package
- title: "Network Processing"
  desc: "Utility functions to prepare networks graphs (represented using data frames) for analysis."
- contents:
  - linestrings_to_graph
  - create_undirected_graph
  - consolidate_graph
  - simplify_network
- title: "Route Choice and Traffic Assignment"
  desc: "Run traffic assignment using path-sized logit model, including efficient built-in route choice algorithm, or all-or-nothing assignment to the shortest path."
- contents:
  - run_assignment
  - print.flownet
- title: "Graph Utilities"
  desc: "Utility functions to normalize graphs (represented using data frames) and extract information from them."
- contents:
  - normalize_graph
  - nodes_from_graph
  - linestrings_from_graph
  - distances_from_graph
- title: "OD-Matrix Utilities"
  desc: "Utility functions to reshape origin-destination flow/trip matrices."
- contents:
  - melt_od_matrix
- title: "Data"
  desc: "Trans-African Road Network and Trade Data"
- contents:
  - africa_cities_ports
  - africa_network
  - africa_segments
  - africa_trade

articles:
  - title: Introduction to flownet
    desc: Introduces the package, including a walk-through of all main features.
    contents:
    - introduction