Skip to content

[WIP] [docs] Make what you can do with zonal very clear #809

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[WIP] [docs] Make what you can do with zonal very clear #809

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
10 changes: 9 additions & 1 deletion src/methods/zonal.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@
Calculate zonal statistics for the the zone of a `Raster` or `RasterStack`
covered by the `of` object/s.

Since `f` is the first argument, you can use Julia's `do`-block syntax with `zonal`,
like so:
```julia
zonal(raster; of = geom) do r # r is an iterator if skipmissing=true, or a raster if skipmissing=false
return r # or do some operation
end
```

# Arguments

- `f`: any function that reduces an iterable to a single value, such as `sum` or `Statistics.mean`
- `f`: any function that reduces an iterable to a single value, such as `sum` or `Statistics.mean` - but it can even be `identity`.
- `x`: A `Raster` or `RasterStack`
- `of`: A `DimTuple`, `Extent`, $OBJ_ARGUMENT

Expand Down
Loading