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

Fixing roxygen issues in RMD Check #510

Merged
merged 7 commits into from
Oct 22, 2016
Merged

Fixing roxygen issues in RMD Check #510

merged 7 commits into from
Oct 22, 2016

Conversation

JackStat
Copy link
Contributor

@JackStat JackStat commented Oct 21, 2016

Please don't merge yet

@JackStat
Copy link
Contributor Author

For the SBF type functions (caretSBF, lmSBF, etc.) they are a list and not a function but they each contain a function. This is causing some conflicts in the documentation because the params are in the function and not the list. Would it break if we made them functions that returned lists?

@topepo
Copy link
Owner

topepo commented Oct 21, 2016

Would it break if we made them functions that returned lists?

Yeah, that would break things.

They are static in the sense that their "syntax" isn't going to change. Can we create a separate non-oxogen Rd file that contains these?

@coveralls
Copy link

coveralls commented Oct 21, 2016

Coverage Status

Coverage remained the same at 14.813% when pulling 6a5a7d0 on JackStat:roxygen into 3fe3dc8 on topepo:master.

@JackStat
Copy link
Contributor Author

Found what I needed to do. I just needed to point the anovaScores function to that set of documentation like it used to be

@coveralls
Copy link

coveralls commented Oct 21, 2016

Coverage Status

Coverage remained the same at 14.813% when pulling 2dbc656 on JackStat:roxygen into 3fe3dc8 on topepo:master.

@JackStat JackStat changed the title 2nd run. dropped some params too Fixing roxygen issues in RMD Check Oct 21, 2016
@topepo
Copy link
Owner

topepo commented Oct 22, 2016

Let me know when you want me to merge. I've tracked down a few missing exports for resamples.R that crash the vignettes.

@coveralls
Copy link

coveralls commented Oct 22, 2016

Coverage Status

Coverage increased (+0.007%) to 14.819% when pulling 4dd6dea on JackStat:roxygen into 3fe3dc8 on topepo:master.

@coveralls
Copy link

coveralls commented Oct 22, 2016

Coverage Status

Coverage increased (+0.007%) to 14.819% when pulling 4dd6dea on JackStat:roxygen into 3fe3dc8 on topepo:master.

@JackStat
Copy link
Contributor Author

Not sure how to fix these...

Undocumented arguments in documentation object 'caret-internal'
  ‘x’ ‘y’ ‘wts’ ‘method’ ‘tuneValue’ ‘obsLevels’ ‘pp’ ‘last’ ‘sampling’
  ‘classProbs’ ‘...’ ‘prefix’ ‘items’ ‘data’ ‘smoother’ ‘cut’ ‘pred’
  ‘obs’ ‘modelFit’ ‘newdata’ ‘preProc’ ‘param’ ‘ind’ ‘testX’ ‘testY’
  ‘sbfControl’ ‘object’ ‘top’ ‘names’ ‘iter’ ‘start’ ‘exclude’ ‘fixed’
  ‘seq’


Documented arguments not in \usage in documentation object 'twoClassSummary':
  ‘formula’ ‘na.rm’ ‘x’
... 27 lines ...

There are also a number of these types of warnings

S3 methods shown with full name in documentation object 'summary.bagEarth':
  ‘summary.bagEarth’

@coveralls
Copy link

coveralls commented Oct 22, 2016

Coverage Status

Coverage increased (+0.007%) to 14.819% when pulling 27a97f4 on JackStat:roxygen into 3fe3dc8 on topepo:master.

@coveralls
Copy link

coveralls commented Oct 22, 2016

Coverage Status

Coverage increased (+0.007%) to 14.819% when pulling 38218b6 on JackStat:roxygen into 3fe3dc8 on topepo:master.

@topepo
Copy link
Owner

topepo commented Oct 22, 2016

Awesome. Thanks for all of the work. I'll merge

@topepo topepo merged commit bb8c2d4 into topepo:master Oct 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants