Skip to content

Commit

Permalink
added describe docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
orbitfold committed Apr 29, 2021
1 parent c5ca7c3 commit aab00cc
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion easyvvuq/analysis/results.py
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,10 @@ def describe(self, qoi=None, statistic=None):
Returns
-------
pandas DataFrame or a numpy array
DataFrame or array
If both quantity of interest and the statistic are specified will return
an array with the values for that statistic. Otherwise will return a DataFrame
with more data.
"""
assert(not ((qoi is None) and (statistic is not None)))
statistics = ['mean', 'var', 'std', '1%', '10%', '90%', '99%', 'min', 'max', 'median']
Expand Down

0 comments on commit aab00cc

Please sign in to comment.