stan-dev / stan-dev/cmdstan

deprecate stansummary option `--autocorr`

Open
#1,287 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

code-cleanup
Dominant language
C++
Stars
238
Forks
106
Avg merge
2h 29m
Merged PRs (30d)
6

Description

Summary:

Deprecate the stansummary option autocorr.

Description:

This option displays the autocorrelations for a single chain for all draws, printed to the console. If the user specifies the -c option, to save the summary as a CSV file, the autocorration information is not saved, but printed to the console.

I've never seen this feature used. If people want it, it should be its own report. It makes the code slightly more difficult to understand and therefore maintain.

Current Version:

v2.35.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the stansummary entry point and trace how the autocorr option is handled. Confirm the project's deprecation process and define the affected user-facing behavior before making changes; done means the option is deprecated consistently and its console and CSV behavior is addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.