Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Parallexaxis doc #249

Merged
merged 8 commits into from
Apr 5, 2023
Merged

Parallexaxis doc #249

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9b291b2
More documentation
quaquel Apr 5, 2023
03ce45a
Update parcoords.py
quaquel Apr 5, 2023
3fa3213
Revert "Update outputspace_exploration_lakeproblem.ipynb"
quaquel Apr 5, 2023
5fef735
More documentation
quaquel Apr 5, 2023
f7a9de8
Update parcoords.py
quaquel Apr 5, 2023
28922d6
Revert "Update outputspace_exploration_lakeproblem.ipynb"
quaquel Apr 5, 2023
6b88e33
Merge branch 'parallexaxis_doc' of https://github.com/quaquel/EMAwork…
quaquel Apr 5, 2023
ae9a479
Revert "Revert "Update outputspace_exploration_lakeproblem.ipynb""
quaquel Apr 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion ema_workbench/analysis/parcoords.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,27 @@ class ParallelAxes:
rot : float, optional
rotation of axis labels


Attributes
----------
limits : DataFrame
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a description of limits

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added the description from the parameters part

recoding : dict
non numeric columns are converting to integer variables
flipped_axes : set
set of Axes that are to be shown flipped
axis_labels : list of str
fontsize : int
normalizer : MinMaxScaler instance
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a description of normalizer

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made this an implementation detail and removed it from the documentation. It is not part of the public API so you don't want to mess with the normalizer.

fig : a matplotlib Figure instance
axes : list of matplotlib Axes instances
ticklabels : list of str
datalabels : list of str
labels associated with lines


The basic setup of the Parallel Axis plot is a row of mpl Axes instances, with all whitespace
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this line have a header, since from here class methods are discussed?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved it into Notes which is the proper place for implementation details

in between removed. The number of Axes is the number of columns - 1.

"""

def __init__(self, limits, formatter=None, fontsize=14, rot=90):
Expand All @@ -155,7 +176,6 @@ def __init__(self, limits, formatter=None, fontsize=14, rot=90):
formatter : dict, optional
specify precision formatters for minima and maxima,
defaults to .2f

fontsize : int, optional
fontsize for defaults text items
rot : float, optional
Expand Down