nest.reportgenerator package
Submodules
nest.reportgenerator.plot_maker module
- nest.reportgenerator.plot_maker.countPlot(df, col)
- nest.reportgenerator.plot_maker.distPlot(data, name)
Constructs a dist plot from set of data
- Parameters:
data – Data assumed to be a column of values for the plot
name – Name used for the title
- Returns:
Figure handle of the resultant plot
- nest.reportgenerator.plot_maker.linePlot(ts, ys, title)
Constructs line plot plot from set of data with no y axis label
- Parameters:
ts – X values for the line plot
ys – Y values for the line plot
title – Title for the plot
- Returns:
Figure handle of the resultant plot
- nest.reportgenerator.plot_maker.linePlotTS(ts, ys, title)
Constructs a temporal line plot from set of data with a axis labels
- Parameters:
ts – X values for the line plot
ys – Y values for the line plot
title – Title for the plot
- Returns:
Figure handle of the resultant plot
- nest.reportgenerator.plot_maker.makeHistogram(data, name, log=False)
Constructs a imshow plot from set of data
- Parameters:
data – Data assumed to be a column of values for the plot
name – Name used for the title
log – Boolean variable which log transforms the y axis
- Returns:
Figure handle of the resultant plot
- nest.reportgenerator.plot_maker.makeImshow(data, name)
Constructs a imshow plot from set of data
- Parameters:
data – Data assumed to be a column of values for the plot
name – Name used for the title
- Returns:
Figure handle of the resultant plot
- nest.reportgenerator.plot_maker.makeSpy(data, name)
Constructs a spy plot from set of data
- Parameters:
data – Data assumed to be a column of values for the plot
name – Name used for the title
- Returns:
Figure handle of the resultant plot
- nest.reportgenerator.plot_maker.neighborhoodPlot(subg)
Constructs a network plot
- Parameters:
subg – A networkx graph
- Returns:
Figure handle of the resultant plot
- nest.reportgenerator.plot_maker.rankPlot(df, col)
Constructs a rank plot from a column of a dataframe
- Parameters:
df – data frame
col – Column to construct the rank plot from.
- Returns:
Figure handle of the resultant plot
nest.reportgenerator.report_generator module
- nest.reportgenerator.report_generator.getAllStatistics(G, reqStats=<function <lambda>>)
Computes all network statistics on a graph graph of choice Note the computed statistics are still in the nest class structure which is used to construct the pdf outputs.
- Parameters:
G – A networkx graph
reqStats – A function to filter the statistics produces defaults to true
- Returns:
A dictionary of the results of each of the statistics
- nest.reportgenerator.report_generator.getAllTimeSeriesStatistics(Gs, reqStats=<function <lambda>>)
Computes all temporal network statistics on a graph graph of choice Note the computed statistics are still in the nest class structure which is used to construct the pdf outputs.
- Parameters:
Gs – A time series of networkx graphs as a dictionary
reqStats – A function to filter the statistics produces defaults to true
- Returns:
A dictionary of the results of each of the statistics
- nest.reportgenerator.report_generator.makeFullReport(rendererClass, df: DataFrame, filename: str, name: str, srcCols: List[str], dstCols: List[str], weightCol: str, timeCol: str, options={}, directed: bool = True)
Main function of Nest. This function takes the dataset, and the renderer and the metadata and combines this into the report.
- Parameters:
rendererClass – The renderer to use to use (e.g. reportlabPDF), see the renderer module for a list of possible options.
df – A pandas dataframe containing the edge list
filename – The filename to store the resultant output
name – The name of the dataset (used for titles)
srcCols – The column(s) used to construct the source node
dstCols – The column(s) used to construct the destination node
weightCol – The column which stores the edge weight. If none the function assumes that all weights are 1.
timeCol – The column which stores the temporal index If none, we assume that the data is static.
- Returns:
Functions saves output to disk.