pyamr.utils package

Subpackages

• pyamr.utils.io package
  • Submodules
  • pyamr.utils.io.read module
    • files_with_extension()
    • read_csv()
    • read_csv_file()
    • read_csv_folder()
    • read_data()
    • read_excel()
    • read_excel_file()
    • read_excel_folder()
    • read_mysql_server()
  • Module contents

Submodules

pyamr.utils.plot module

Classes:

MidpointNormalize([vmin, vmax, midpoint, clip])

Normalise the colorbar so that diverging bars work their way either side from a prescribed midpoint value)

Functions:

create_mapper(dataframe, column_key, ...)	This method constructs a mapper
get_category_colors(index, category[, cmap])	Creates the colors for the different elements in a given categorical feature vector.
hlinebgplot(ax, right, yv[, bg])	This function adds a vertical line and background
plot_sns_clustermap()
plot_sns_heatmap()
plot_sns_relmap()
plot_spectrum()
plot_timeseries()
scalar_colormap(values, cmap, vmin, vmax)	This method creates a colormap based on values.
vlinebgplot(ax, top, xv[, bg])	This function adds a vertical line and background

class pyamr.utils.plot.MidpointNormalize(vmin=None, vmax=None, midpoint=None, clip=False)

Bases: Normalize

Normalise the colorbar so that diverging bars work their way either side from a prescribed midpoint value)

Example

> MidpointNormalize(midpoint=0., vmin=-100, vmax=100)

pyamr.utils.plot.create_mapper(dataframe, column_key, column_value)

This method constructs a mapper

Parameters:

• dataframe (dataframe-like) – The dataframe from which the columns are extracted

• column_key (string-like) – The name of the column with the values for the keys of the mapper

• column_value (string-like) – The name of the column with the values for the values of the mapper

Return type:

dictionary

pyamr.utils.plot.get_category_colors(index, category, cmap='hls')

Creates the colors for the different elements in a given categorical feature vector.

Parameters:

• values (array-like) – The vector with the categorical values

• cmap (string-like) – The colormap to use

• default (string-like) – The color to be used for the first value. Note that this value needs to appear first on the the sorted list, as such it is recommended to set is as _default.

Returns:

List of colors.

Return type:

pd.Series

pyamr.utils.plot.hlinebgplot(ax, right, yv, bg=None)

This function adds a vertical line and background

pyamr.utils.plot.plot_sns_clustermap()

pyamr.utils.plot.plot_sns_heatmap()

pyamr.utils.plot.plot_sns_relmap()

pyamr.utils.plot.plot_spectrum()

pyamr.utils.plot.plot_timeseries()

pyamr.utils.plot.scalar_colormap(values, cmap, vmin, vmax)

This method creates a colormap based on values.

Parameters:

• values (array-like)

• The values to create the corresponding colors

• cmap (str)

• The colormap

• vmin, vmax (float)

• The minimum and maximum possible values

Return type:

scalar colormap

pyamr.utils.plot.vlinebgplot(ax, top, xv, bg=None)

This function adds a vertical line and background

Parameters:

• ax (matplotlib axes)

• top (float) – The max y value

• xv (float) – The x value

• bg (boolean) – Whether to include a background

Module contents