Skip to content

API reference

One page per module. Signatures are generated from the source with their type annotations; descriptions come from the numpy-style docstrings.

  • netviz_tools: what the top-level package re-exports.
  • clean: clean, CleaningReport, CleaningStep, MirrorStats.
  • graph: build_graph, graphs_by, graph_to_flows.
  • analysis: partners, compare_categories.
  • metrics: centrality, communities, modularity, community_graph.
  • temporal: metric_series, centrality_series, graph_summary.
  • stats: degree_distribution_fit, fit_power_law, PowerLawFit, DistributionComparison.
  • plot: auto, network, ego, flow_map, sankey, adjacency, ranking, compare, time_series, degree_distribution, community_layout, choose_kind.
  • datasets.faostat: load, load_sample, build_store, download, store_info, store_path, default_cache_dir, items, countries, CITATION, LABELS.
  • errors: the exception hierarchy.
  • schema: the flow-frame schema, to_flowframe, validate_flows.