From c8242564ff8dbdf6dadfde776ec02240047ad7fd Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 2 Feb 2024 17:28:44 +0000 Subject: [PATCH] Update documentation --- api.html | 8 ++++---- full_ref.html | 18 +++++++++--------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/api.html b/api.html index 6fa941c1..d6d72c84 100644 --- a/api.html +++ b/api.html @@ -155,7 +155,7 @@

Adjacency graphs
-add_data(df: <Mock name='mock.DataFrame' id='140259869673408'>, columns: Optional[Iterable[str]] = None) → None[source]
+add_data(df: <Mock name='mock.DataFrame' id='139991199799232'>, columns: Optional[Iterable[str]] = None) → None[source]

Add columns of a DataFrame to a graph as node attributes by matching the DataFrame’s index to node ids.

@@ -211,7 +211,7 @@

Adjacency graphs
-classmethod from_geodataframe(dataframe: <Mock name='mock.DataFrame' id='140259869673408'>, adjacency: str = 'rook', cols_to_add: Optional[List[str]] = None, reproject: bool = False, ignore_errors: bool = False) → gerrychain.graph.graph.Graph[source]
+classmethod from_geodataframe(dataframe: <Mock name='mock.DataFrame' id='139991199799232'>, adjacency: str = 'rook', cols_to_add: Optional[List[str]] = None, reproject: bool = False, ignore_errors: bool = False) → gerrychain.graph.graph.Graph[source]

Creates the adjacency Graph of geometries described by dataframe. The areas of the polygons are included as node attributes (with key area). The shared perimeter of neighboring polygons are included as edge attributes @@ -311,7 +311,7 @@

Adjacency graphs
-join(dataframe: <Mock name='mock.DataFrame' id='140259869673408'>, columns: Optional[List[str]] = None, left_index: Optional[str] = None, right_index: Optional[str] = None) → None[source]
+join(dataframe: <Mock name='mock.DataFrame' id='139991199799232'>, columns: Optional[List[str]] = None, left_index: Optional[str] = None, right_index: Optional[str] = None) → None[source]

Add data from a dataframe to the graph, matching nodes to rows when the node’s left_index attribute equals the row’s right_index value.

@@ -1328,7 +1328,7 @@

Markov chains
-class gerrychain.updaters.DataTally(data: Union[Dict, <Mock name='mock.Series' id='140259869673504'>, str], alias: str)[source]
+class gerrychain.updaters.DataTally(data: Union[Dict, <Mock name='mock.Series' id='139991199799328'>, str], alias: str)[source]

An updater for tallying numerical data that is not necessarily stored as node attributes

diff --git a/full_ref.html b/full_ref.html index 95330f8a..1e23fbf5 100644 --- a/full_ref.html +++ b/full_ref.html @@ -1585,7 +1585,7 @@

Graph
-gerrychain.graph.adjacency.neighbors(df: <Mock name='mock.GeoDataFrame' id='140259870126480'>, adjacency: str) → Dict[source]
+gerrychain.graph.adjacency.neighbors(df: <Mock name='mock.GeoDataFrame' id='139991199723920'>, adjacency: str) → Dict[source]
@@ -1691,7 +1691,7 @@

Graph
-gerrychain.graph.geo.identify_utm_zone(df: <Mock name='mock.GeoDataFrame' id='140259870126480'>) → int[source]
+gerrychain.graph.geo.identify_utm_zone(df: <Mock name='mock.GeoDataFrame' id='139991199723920'>) → int[source]

Given a GeoDataFrame, identify the Universal Transverse Mercator zone number for the centroid of the geometries in the dataframe.

@@ -1851,7 +1851,7 @@

Graph
-add_data(df: <Mock name='mock.DataFrame' id='140259869673408'>, columns: Optional[Iterable[str]] = None) → None[source]
+add_data(df: <Mock name='mock.DataFrame' id='139991199799232'>, columns: Optional[Iterable[str]] = None) → None[source]

Add columns of a DataFrame to a graph as node attributes by matching the DataFrame’s index to node ids.

@@ -1912,7 +1912,7 @@

Graph
-classmethod from_geodataframe(dataframe: <Mock name='mock.DataFrame' id='140259869673408'>, adjacency: str = 'rook', cols_to_add: Optional[List[str]] = None, reproject: bool = False, ignore_errors: bool = False) → gerrychain.graph.graph.Graph[source]
+classmethod from_geodataframe(dataframe: <Mock name='mock.DataFrame' id='139991199799232'>, adjacency: str = 'rook', cols_to_add: Optional[List[str]] = None, reproject: bool = False, ignore_errors: bool = False) → gerrychain.graph.graph.Graph[source]

Creates the adjacency Graph of geometries described by dataframe. The areas of the polygons are included as node attributes (with key area). The shared perimeter of neighboring polygons are included as edge attributes @@ -2012,7 +2012,7 @@

Graph
-join(dataframe: <Mock name='mock.DataFrame' id='140259869673408'>, columns: Optional[List[str]] = None, left_index: Optional[str] = None, right_index: Optional[str] = None) → None[source]
+join(dataframe: <Mock name='mock.DataFrame' id='139991199799232'>, columns: Optional[List[str]] = None, left_index: Optional[str] = None, right_index: Optional[str] = None) → None[source]

Add data from a dataframe to the graph, matching nodes to rows when the node’s left_index attribute equals the row’s right_index value.

@@ -2100,7 +2100,7 @@

Graph
-gerrychain.graph.graph.add_boundary_perimeters(graph: gerrychain.graph.graph.Graph, geometries: <Mock name='mock.Series' id='140259869673504'>) → None[source]
+gerrychain.graph.graph.add_boundary_perimeters(graph: gerrychain.graph.graph.Graph, geometries: <Mock name='mock.Series' id='139991199799328'>) → None[source]

Add shared perimeter between nodes and the total geometry boundary.

Parameters
@@ -2120,7 +2120,7 @@

Graph
-gerrychain.graph.graph.check_dataframe(df: <Mock name='mock.DataFrame' id='140259869673408'>) → None[source]
+gerrychain.graph.graph.check_dataframe(df: <Mock name='mock.DataFrame' id='139991199799232'>) → None[source]
Returns

None

@@ -2516,7 +2516,7 @@

Partition
-to_series() → <Mock name='mock.Series' id='140259869673504'>[source]
+to_series() → <Mock name='mock.Series' id='139991199799328'>[source]
Returns

The assignment as a pandas.Series.

@@ -4483,7 +4483,7 @@

Updaters
-class gerrychain.updaters.tally.DataTally(data: Union[Dict, <Mock name='mock.Series' id='140259869673504'>, str], alias: str)[source]
+class gerrychain.updaters.tally.DataTally(data: Union[Dict, <Mock name='mock.Series' id='139991199799328'>, str], alias: str)[source]

Bases: object

An updater for tallying numerical data that is not necessarily stored as node attributes