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

DALEXverse 0.19.8 release summer 2019 #20

Closed
14 tasks done
pbiecek opened this issue Aug 22, 2019 · 4 comments
Closed
14 tasks done

DALEXverse 0.19.8 release summer 2019 #20

pbiecek opened this issue Aug 22, 2019 · 4 comments
Assignees
Labels
before release 📌 TODO before release

Comments

@pbiecek
Copy link
Member

pbiecek commented Aug 22, 2019

DALEXverse 0.19.8 release summer 2019

Integration

  • readability: vignettes
  • readability: NEWS
  • readability: DESCRIPTION
  • consistency: pkgdown website
  • consistency: entry at DrWhy.AI webpage

assigned: @pbiecek

Code review

  • consistency: names of functions
  • consistency: names of files
  • consistency: names of variables in functions (local and global)
  • length: functions
  • readability: code (comments, constructions)

assigned: @maksymiuks

Feature review

  • readability: documentation (title, description, details)
  • readability: examples (relevant, complete, with comments)
  • reproducibility: tests (code coverage)
  • links to functions: \code

assigned: @WojciechKretowicz

@maksymiuks
Copy link
Member

maksymiuks commented Aug 22, 2019

I've finished R code review, here are my thoughts:

@pbiecek pbiecek added this to the First CRAN release v0.2 milestone Aug 22, 2019
@WojciechKretowicz
Copy link

  • there is no link to main vignette on github, there is only link to 'perk and features', i've got lost at the very beginning
  • what is model studio, in my opinion you could tell that model studio is a function in your package, just at the top of the vignette
  • in the Wrap it into an explainer paragraph deleting sixth column could be more explicite, while going through your examples in R session it is not a problem, however just reading them is a little bit confusing
  • in my opinion N and B in the example in the main vignette should be deleted or be described
  • big plus for those videos
  • function getOptions is very confusing for me, when I was reading vignette i thought that this is R's getOption function, difference between those two object was clear for me after going to Reference site, i think you could change the name of it or write very explicitly that this is different function from getOption
  • in my opinion in Generates interactive studio to explain predictive model there is no visible difference between # S3 method for explainer and # S3 method for default
  • i think that parameter x in modelStudio could be changed into something more clear, especially that there is also parameter y that does not correspond to x in natural way
  • i think that warnings in modelStudio should be suppressed
  • in getOptions parameter margin_x is confusing for me
  • in my opinion you could more clearly describe the xx_* parameters, after reading the vignette i cannot point their usage
  • again warnings, this time in getOptions

@hbaniecki
Copy link
Member

hbaniecki commented Aug 22, 2019

hbaniecki pushed a commit that referenced this issue Aug 22, 2019
many minor changes stated in #20, most notably:
* rename `x` parameter to `object` in `modelStudio()`
* rename `getOptions()` to `modelStudioOptions()`
* add `viewer` parameter to `modelStudio()`
* add suppressWarnings(ingredients::describe)
* upgrade documentation, examples and vignette
pbiecek added a commit that referenced this issue Aug 24, 2019
@pbiecek
Copy link
Member Author

pbiecek commented Aug 24, 2019

imho it's ready for CRAN

@pbiecek pbiecek closed this as completed Aug 27, 2019
@hbaniecki hbaniecki added the before release 📌 TODO before release label Apr 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
before release 📌 TODO before release
Projects
None yet
Development

No branches or pull requests

4 participants