Add alias for blockmean's -S parameter

[michaelgrund]

Description of proposed changes

According to #1598 this PR add an alias for the -S parameter of blockmean.

Reminders

• Run make format and make check to make sure the code follows the style guide.
• Add tests for new features or tests that would have caught the bug that you're fixing.
• Add new public functions/methods/classes to doc/api/index.rst.
• Write detailed docstrings for all functions/methods.
• If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

• /format: automatically format and lint the code
• /test-gmt-dev: run full tests on the latest GMT development version

[willschlitzer]

@michaelgrund Sorry to leave you hanging, but I haven't had the chance to check out this branch yet!

[michaelgrund]

@michaelgrund Sorry to leave you hanging, but I haven't had the chance to check out this branch yet!

No worries @willschlitzer 😉

[willschlitzer]

I'm not familiar with the use of blockmean, but I'm getting the exact same output when I change the arguments to restype. I'm using the input data specified in test_blockmean_input_xyz(). Is this supposed to be the case?

[maxrjones]

I'm not familiar with the use of blockmean, but I'm getting the exact same output when I change the arguments to restype. I'm using the input data specified in test_blockmean_input_xyz(). Is this supposed to be the case?

I get different results depending on the argument. Maybe try a git status to check the branch and make clean; make install?

import pygmt
data = pygmt.datasets.load_sample_bathymetry()
region = pygmt.info(data, spacing=1)
pygmt.blockmean(data=data, spacing="1m", restype="w", region=region).head(1)

longitude	latitude	bathymetry
245.88819	29.97895	1

pygmt.blockmean(data=data, spacing="1m", restype="m", region=region).head(1)

longitude	latitude	bathymetry
245.88819	29.97895	-385.0

restype is not my favorite alias for this parameter because I think truncated words are not the quickest to interpret. I would prefer something like statistic. But, it's not that strong of an opinion if @michaelgrund prefers to stick with the restype.

[michaelgrund]

restype is not my favorite alias for this parameter because I think truncated words are not the quickest to interpret. I would prefer something like statistic. But, it's not that strong of an opinion if @michaelgrund prefers to stick with the restype.

Thanks for you comment @meghanrjones. I'm fully open for other suggestions for the alias. Indeed, statistic would fit better than restype. Another alternative would be e.g. summarize since the calculated values represent a summary of the data in each block based on different metrics (mean, count, sum, sum of weights).

[maxrjones]

restype is not my favorite alias for this parameter because I think truncated words are not the quickest to interpret. I would prefer something like statistic. But, it's not that strong of an opinion if @michaelgrund prefers to stick with the restype.

Thanks for you comment @meghanrjones. I'm fully open for other suggestions for the alias. Indeed, statistic would fit better than restype. Another alternative would be e.g. summarize since the calculated values represent a summary of the data in each block based on different metrics (mean, count, sum, sum of weights).

summarize sounds good!

[seisman]

restype is not my favorite alias for this parameter because I think truncated words are not the quickest to interpret. I would prefer something like statistic. But, it's not that strong of an opinion if @michaelgrund prefers to stick with the restype.

Thanks for you comment @meghanrjones. I'm fully open for other suggestions for the alias. Indeed, statistic would fit better than restype. Another alternative would be e.g. summarize since the calculated values represent a summary of the data in each block based on different metrics (mean, count, sum, sum of weights).

Do you think summary (noun) is better than summarize (verb)?

[willschlitzer]

I'm not familiar with the use of blockmean, but I'm getting the exact same output when I change the arguments to restype. I'm using the input data specified in test_blockmean_input_xyz(). Is this supposed to be the case?

I get different results depending on the argument. Maybe try a git status to check the branch and make clean; make install?

Maybe I set up my Jupyter Notebook badly, but I'm now getting different results. Looks like it works!

[michaelgrund]

Do you think summary (noun) is better than summarize (verb)?

I'm open for this, what do the others think is the better choice?

[willschlitzer]

Do you think summary (noun) is better than summarize (verb)?

I'm open for this, what do the others think is the better choice?

I think summary works better; summarize seems like it would make sense for a True/False argument.

[seisman]

/format