From cfc640c9296c6a15ece39599d0bacc4ec88a4011 Mon Sep 17 00:00:00 2001 From: Michael Grund <23025878+michaelgrund@users.noreply.github.com> Date: Sun, 13 Feb 2022 07:29:49 +0100 Subject: [PATCH] Add inline example for blockmedian (#1730) Co-authored-by: Meghan Jones Co-authored-by: Dongdong Tian --- pygmt/src/blockm.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/pygmt/src/blockm.py b/pygmt/src/blockm.py index 5adc6a694e5..fdd786a91d4 100644 --- a/pygmt/src/blockm.py +++ b/pygmt/src/blockm.py @@ -225,6 +225,16 @@ def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs): is not set. - None if ``outfile`` is set (filtered output will be stored in file set by ``outfile``). + + Example + ------- + >>> import pygmt # doctest: +SKIP + >>> # Load a table of ship observations of bathymetry off Baja California + >>> data = pygmt.datasets.load_sample_data(name="bathymetry") + >>> # Calculate block median values within 5 by 5 minute bins + >>> data_bmedian = pygmt.blockmedian( + ... data=data, region=[245, 255, 20, 30], spacing="5m" + ... ) # doctest: +SKIP """ return _blockm( block_method="blockmedian", data=data, x=x, y=y, z=z, outfile=outfile, **kwargs