stan-dev / stan-dev/rstan

doc for init in vb()

Open
#264 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
R
Stars
1.1k
Forks
266
Avg merge
2h 56m
Merged PRs (30d)
1

Description

There's no doc for initialization in the vb() command, but it allows the argument.

And if I give it bogus arguments, I get this:

> vb(foo="bar")
Error in (function (classes, fdef, mtable)  : 
  unable to find an inherited method for function ‘vb’ for signature ‘"missing"’

Is there a way to make a cleaner error message of some kind? If I give it one known argument and an unknown one, it provides the right kind of message (with behavior for unknown arguments matching R's own lm() function):

> vb(sm, foo="bar")

This is Automatic Differentiation Variational Inference.
...
In addition: Warning message:
passing unknown arguments: foo. 
> 

Contributor guide

No contributing guide indexed for this repository

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 vb() entry point and inspect its existing argument handling and documentation. Reproduce vb(foo="bar") and the mixed known/unknown argument case to understand the current behavior. Done means documenting initialization arguments and defining or recording a clearer response for invalid-only arguments.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.