Skip to content

DOC: correction for zonal.stats docstring #40

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

Merged
merged 1 commit into from
May 24, 2020
Merged

DOC: correction for zonal.stats docstring #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions xrspatial/zonal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def stats(zones, values, stat_funcs=['mean', 'max', 'min', 'std', 'var']):
The input value raster contains the input values used in calculating
the output statistic for each zone.

stats: list of strings or dictionary<stat_name: function(zone_values)>.
stat_funcs: list of strings or dictionary<stat_name: function(zone_values)>.
Which statistics to calculate for each zone.
If a list, possible choices are subsets of
['mean', 'max', 'min', 'std', 'var']
Expand Down Expand Up @@ -66,7 +66,7 @@ def stats(zones, values, stat_funcs=['mean', 'max', 'min', 'std', 'var']):

# custom stat
>>> custom_stats ={'sum': lambda val: val.sum()}
>>> df = stats(zones, values)
>>> df = stats(zones, values, stat_funcs=custom_stats)
>>> df
sum
1 21.0
Expand Down