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

Add useful information in the flow description #276

Open
joaquinvanschoren opened this issue Sep 9, 2016 · 2 comments
Open

Add useful information in the flow description #276

joaquinvanschoren opened this issue Sep 9, 2016 · 2 comments

Comments

@joaquinvanschoren
Copy link
Contributor

Currently, no description of flows is added in the XML that is uploaded. Please add as much useful information as possible:

  • Link to MLR tutorial?
  • Link to documentation of packages used (e.g. e1071 on CRAN)?
  • Short textual description of the learning algorithms
  • List of involved preprocessing steps with links to further documentation?
  • References for further reading?
  • Code snippets on how to run the flow in mlr?

You can use markdown (and even math), it will be rendered on the website:
https://github.com/gollum/gollum/wiki

@giuseppec
Copy link
Member

giuseppec commented Sep 16, 2016

It is a bit ugly to extract information form help pages, but this might help:

x = XML::htmlParse(capture.output(tools:::Rd2HTML(utils:::.getHelpFile(help("mean")))))
XML::readHTMLTable(x)

@giuseppec
Copy link
Member

This should be possible now using learnerHelp from mlr-org/mlr#1657

@giuseppec giuseppec added this to the 1.4 milestone Apr 4, 2017
@giuseppec giuseppec removed this from the 1.4 milestone Feb 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants