Skip to content

Commit

Permalink
updated README, added NEWS
Browse files Browse the repository at this point in the history
  • Loading branch information
mllg committed Nov 18, 2016
1 parent 4d85d98 commit 932e3fb
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 40 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ insert_final_newline = true
indent_style = space
trim_trailing_whitespace = true

[*.md]
indent_size = 2

[*.{r,R}]
indent_size = 2

Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ Suggests:
eaf
LazyData: yes
ByteCompile: yes
Version: 1.0
Version: 1.0.0
RoxygenNote: 5.0.1
3 changes: 3 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# mlrMBO 1.0.0

* Initial CRAN release
50 changes: 11 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,26 @@
# mlrMBO


Model-based optimization with mlr

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/mlrMBO)](https://cran.r-project.org/package=mlrMBO)
[![Build Status](https://travis-ci.org/mlr-org/mlrMBO.png?branch=master)](https://travis-ci.org/mlr-org/mlrMBO) master <br />
[![Build status](https://ci.appveyor.com/api/projects/status/gvr607kqcl78qjq9/branch/master?svg=true)](https://ci.appveyor.com/project/jakob-r/mlrmbo/branch/master) windows <br />
[![Build Status](https://travis-ci.org/mlr-org/mlrMBO.png?branch=gh-pages)](https://travis-ci.org/mlr-org/mlrMBO) tutorial <br />


The package will be released soon, so some links below are not working.

* [Offical CRAN release site](http://cran.r-project.org/web/packages/mlrMBO/index.html) (*not available yet*)

* [Tutorial on github](http://mlr-org.github.io/mlrMBO/devel/html/) (*work in progress*)
Model-based optimization with [mlr](https://github.com/mlr-org/mlr/).

# Installation

The package has not been released on CRAN yet. Run the following command in R to install the current GitHub version.

To install packages directly from github use the `install_github()` function from `devtools`.

```r
install.packages("devtools")
```

Before you can install `mlrMBO` you need the current github versions of both [mlr](https://github.com/mlr-org/mlr/) and [ParamHelpers](https://github.com/berndbischl/ParamHelpers).
`mlrMBO` currently needs the development versions of the packages [mlr](https://github.com/mlr-org/mlr/) and [ParamHelpers](https://github.com/berndbischl/ParamHelpers).
To install `mlrMBO` with all dependencies, run the following lines:

```r
library(devtools)
install_github("berndbischl/ParamHelpers")
install_github("mlr-org/mlr")
devtools::install_github("berndbischl/ParamHelpers")
devtools::install_github("mlr-org/mlr")
devtools::install_github("mlr-org/mlrMBO")
```

Then you can easily install.

```r
install_github("mlr-org/mlrMBO")
```

Àll other dependencies will be installed automatically from CRAN.


[Further installation instructions](https://github.com/rdatsci/PackagesInfo/wiki/Installation-Information) are available at the site of tudo-r
# Resources

# Mailinglist and Email-Service-Hook

Developers use this mailing list:

https://groups.google.com/forum/?hl=de#!forum/mlrmbo-devel

[email protected]

The github-service-hook will also send commit messages to this list.
* [Tutorial on github](http://mlr-org.github.io/mlrMBO/devel/html/) (*work in progress*)
* Developers mailing list at [google groups](https://groups.google.com/forum/?hl=de#!forum/mlrmbo-devel).
The github-service-hook will also send commit messages to this list.

0 comments on commit 932e3fb

Please sign in to comment.