Skip to content
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.

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

[moved to cmdstan] Rename print to something more specific #664

Closed
tmalsburg opened this issue May 22, 2014 · 5 comments
Closed

[moved to cmdstan] Rename print to something more specific #664

tmalsburg opened this issue May 22, 2014 · 5 comments
Assignees
Labels
Milestone

Comments

@tmalsburg
Copy link
Contributor

The name print is already taken by other Unix tools. Installing print on Unix-like systems may therefore lead to conflicts. Apart from that, print is not very informative as a name. The issue came up in #630 and I proposed to rename print to stansummary (reminiscent of R's summary function which does something similar for mixed models). @bob-carpenter proposed mcmcprint and stanprint. I like the use of stan as a prefix for all stan-binaries because that is informative and it reduces the probability of naming conflicts with other software packages.

Changing the name would probably require changes in some other places as well: documentation, other software that builds on stan (stan-mode.el for example), etc. Not at least, the users have to relearn the command. Nevertheless, it might make sense to change it.

@bob-carpenter
Copy link
Contributor

I think it makes sense to change it. It was a terrible
name for a command!

Any suggestions for what it should be?

  • Bob

On May 22, 2014, at 9:35 AM, Titus von der Malsburg notifications@github.com wrote:

The name print is already taken by other Unix tools. Installing print on Unix-like systems may therefore lead to conflicts. Apart from that, print is not very informative as a name. The issue came up in #630 and I proposed to rename print to stansummary (reminiscent of R's summary function which does something similar for mixed models). @bob-carpenter proposed mcmcprint and stanprint. I like the use stan as a prefix for all stan-binaries because that is informative and it reduces the probability of naming conflicts with other software packages.

Changing the name would probably require changes in some other places as well: documentation, other software that builds on stan (stan-mode.el for example), etc. Not at least, the users have to relearn the command. Nevertheless, it might make sense to change it.


Reply to this email directly or view it on GitHub.

@betanalpha
Copy link
Contributor

I dislike summary — we’re not summarizing the samples but rather using them
to compute expectations. It’s really the third step of MCMC (after convergence
and then sampling). To that end, maybe something like

mcmc_evaluate
mcmc_compute
mcmc_calc

On May 22, 2014, at 12:34 PM, Bob Carpenter notifications@github.com wrote:

I think it makes sense to change it. It was a terrible
name for a command!

Any suggestions for what it should be?

  • Bob

On May 22, 2014, at 9:35 AM, Titus von der Malsburg notifications@github.com wrote:

The name print is already taken by other Unix tools. Installing print on Unix-like systems may therefore lead to conflicts. Apart from that, print is not very informative as a name. The issue came up in #630 and I proposed to rename print to stansummary (reminiscent of R's summary function which does something similar for mixed models). @bob-carpenter proposed mcmcprint and stanprint. I like the use stan as a prefix for all stan-binaries because that is informative and it reduces the probability of naming conflicts with other software packages.

Changing the name would probably require changes in some other places as well: documentation, other software that builds on stan (stan-mode.el for example), etc. Not at least, the users have to relearn the command. Nevertheless, it might make sense to change it.


Reply to this email directly or view it on GitHub.


Reply to this email directly or view it on GitHub.

@tmalsburg
Copy link
Contributor Author

Underscores are extremely uncommon in the names of executables. Perhaps it's better to use dashes, e.g., mcmc-evaluate.

@bob-carpenter
Copy link
Contributor

Absolutely --- we should use hyphens as defaults
in file names, but underscores in C++ functions. I've tried
to do that everywhere, but I don't think all of our file naming
is consistent (even by me).

The exception is when we have a file named after a C++ function.
Then I think we should use the underscores. So that'd mean it
should really be:

foo_bar-test.cpp

for our tests if we follow that convention, but given that they're
not exposed, I don't feel the need to change them.

  • Bob

On May 22, 2014, at 3:20 PM, Titus von der Malsburg notifications@github.com wrote:

Underscores are extremely uncommon in the names of executables. Perhaps it's better to use dashes, e.g., mcmc-evaluate.


Reply to this email directly or view it on GitHub.

@syclik syclik changed the title Rename print to something more specific [moved to cmdstan] Rename print to something more specific Aug 9, 2014
@syclik syclik added the build label Aug 9, 2014
@syclik syclik added this to the v2.4.0++ milestone Aug 9, 2014
@syclik syclik self-assigned this Aug 9, 2014
@syclik
Copy link
Member

syclik commented Aug 9, 2014

moved to stan-dev/cmdstan#49.

@syclik syclik closed this as completed Aug 9, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants