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

DOCS: Update docs add FAQ page #1527

Merged
merged 5 commits into from Mar 28, 2014

Conversation

Projects
None yet
2 participants
@jseabold
Copy link
Member

commented Mar 28, 2014

This will close #1311, #1450, and #1526.

I added an FAQ page. I updated the introduction page and removed the redundant and out of date stuff. It seems more like an about page, so I renamed it.

Fixed some broken links and formatting issues.

How does statsmodels handle missing data?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Missing data can be handled via te ``missing`` keyword argument. Every model takes this keyword. You can find more information in the docstring of :class:`statsmodels.base.Model`.

This comment has been minimized.

Copy link
@josef-pkt

josef-pkt Mar 28, 2014

Member

te -> the

What if my question isn't answered here?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You may find answers for questions that have not yet been added here on GitHub under the `FAQ issues tag <https://github.com/statsmodels/statsmodels/issues?labels=FAQ&page=1&state=open>`_. If not, please ask your question there or on the `mailing list <https://groups.google.com/forum/#!forum/pystatsmodels>`_.

This comment has been minimized.

Copy link
@josef-pkt

josef-pkt Mar 28, 2014

Member

please ask your question there might misuse our issue tracker
It would be good to have a central location for frequently asked question, but basic usage questions would be better on stackoverflow or the mailing list.

expect many large changes going forward. Although there is no guarantee yet
on API stability, we have long deprecation periods in all but very special
cases, and we try to keep changes that require adjustments by existing users
to a minimal level.

This comment has been minimized.

Copy link
@josef-pkt

josef-pkt Mar 28, 2014

Member

I'm not sure this doesn't sound to strong.

I think we are not at the stage of scipy, where Ralf enforces immediate deprecation requirement for any new code.

I had added this before

New models that have just been
 -included might require adjustments as we gain more experience and obtain
 -feedback by users. As we expand the range of models, we keep improving the
 -framework for different estimators and statistical tests, so further changes
 -will be necessary.

???

development of statsmodels:

Google `www.google.com <http://www.google.com/>`_ : Google Summer of Code
(GSOC) 2009-2014

This comment has been minimized.

Copy link
@josef-pkt

josef-pkt Mar 28, 2014

Member

2009-2013 we don't have 2014 yet (but I think we will)

@josef-pkt

This comment has been minimized.

Copy link
Member

commented Mar 28, 2014

looks good

my comment for #1526 was "I'm in favor of radical trimming, and update what's left over."
since I didn't hit enter it's already done before my comment

One thought I had was to turn "about" into something that could go into a press release or Wikipedia, but without the duplicated table of content (that you deleted).
code stability could go somewhere else, maybe

eventually some place with a list of users of statsmodels would also be good. (only we don't know much who does)

@jseabold

This comment has been minimized.

Copy link
Member Author

commented Mar 28, 2014

On Thu, Mar 27, 2014 at 8:51 PM, Josef Perktold notifications@github.comwrote:

eventually some place with a list of users of statsmodels would also be
good. (only we don't know much who does)

We should definitely solicit quotes from industry types who are using. I
know there are some that I've spoken too. I'll be giving some talks here in
DC on statsmodels in April. I'll ask people to let us know.

@jseabold

This comment has been minimized.

Copy link
Member Author

commented Mar 28, 2014

Addressed comments.

@jseabold

This comment has been minimized.

Copy link
Member Author

commented Mar 28, 2014

It occurred to me that we'll eventually need an FAQ by topic. E.g., causes of estimation difficulties in ARMA. P-values in RLM, etc.

@jseabold

This comment has been minimized.

Copy link
Member Author

commented Mar 28, 2014

Merging this.

jseabold added a commit that referenced this pull request Mar 28, 2014

Merge pull request #1527 from jseabold/update-docs
DOCS: Update docs add FAQ page

@jseabold jseabold merged commit 80f7fa3 into statsmodels:master Mar 28, 2014

1 check passed

default The Travis CI build passed
Details

@jseabold jseabold deleted the jseabold:update-docs branch Mar 28, 2014

@josef-pkt josef-pkt added the PR label Apr 14, 2014

PierreBdR pushed a commit to PierreBdR/statsmodels that referenced this pull request Sep 2, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.