Skip to content

Commit

Permalink
Export Methods and Updates Documentation (#321)
Browse files Browse the repository at this point in the history
  • Loading branch information
Nosferican authored and ararslan committed Nov 28, 2017
1 parent cd95f18 commit fad9642
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/src/statmodels.md
Expand Up @@ -10,6 +10,7 @@ aic
aicc
bic
coef
coefnames
coeftable
confint
deviance
Expand All @@ -28,6 +29,7 @@ vcov
```@docs
dof_residual
fitted
modelmatrix
model_response
predict
predict!
Expand Down
4 changes: 3 additions & 1 deletion src/StatsBase.jl
Expand Up @@ -127,7 +127,7 @@ module StatsBase
hist,
# histrange,
midpoints,

## robust
trim, # trimmed set
trim!, # trimmed set
Expand All @@ -154,6 +154,7 @@ module StatsBase
aicc,
bic,
coef,
coefnames,
coeftable,
confint,
deviance,
Expand All @@ -163,6 +164,7 @@ module StatsBase
fit!,
fitted,
loglikelihood,
modelmatrix,
nobs,
nulldeviance,
nullloglikelihood,
Expand Down

5 comments on commit fad9642

@andyreagan
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This export overlaps with StatsModels.jl, which also exports coefnames.

The issues show up in packages that use both (cc @dmbates, in MixedModels.jl).

Apologies for my lack of digging to answer my own question here, but are you all aware of https://github.com/JuliaStats/StatsModels.jl and trying to play nice with that separation or no?

@dmbates
Copy link
Contributor

@dmbates dmbates commented on fad9642 Dec 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andyreagan I think the best way out of this problem is to create a new release of StatsModels that doesn't export coefnames. The changes are already in the StatsModels master branch but we should wait for the Travis-CI run (https://travis-ci.org/JuliaStats/StatsModels.jl) #200 to finish before making a release. (The test failures on julia:nightly are unrelated to the change.)

If you want to try it in the meantime, use

Pkg.checkout("StatsModels")

to get a version of StatsModels that is compatible with StatsBase 0.19.2.

@andyreagan
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay cool. I wasn't sure which package follows which's lead. Will just check that out.

@dmbates
Copy link
Contributor

@dmbates dmbates commented on fad9642 Dec 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v0.2.0 of StatsModels has now been released so the problem of both packages exporting coefnames should be resolved.

By the way, v0.19.2 of StatsBase should have been v0.20.0 because the exporting of coefnames was a breaking change.

@nalimilan
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exporting a new function is certainly not a breaking change. Both packages can still be used together, you just need to qualify the function when calling it (until StatsModels 0.2.0).

Please sign in to comment.