diff --git a/.editorconfig b/.editorconfig index 78398c6aa..d6072a713 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,6 +8,9 @@ insert_final_newline = true indent_style = space trim_trailing_whitespace = true +[*.md] +indent_size = 2 + [*.{r,R}] indent_size = 2 diff --git a/DESCRIPTION b/DESCRIPTION index 1830f5826..dd8ead9c9 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -48,5 +48,5 @@ Suggests: eaf LazyData: yes ByteCompile: yes -Version: 1.0 +Version: 1.0.0 RoxygenNote: 5.0.1 diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 000000000..6a0b0a88e --- /dev/null +++ b/NEWS.md @@ -0,0 +1,3 @@ +# mlrMBO 1.0.0 + +* Initial CRAN release diff --git a/README.md b/README.md index bd1ceb1fe..793db3957 100644 --- a/README.md +++ b/README.md @@ -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
[![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
[![Build Status](https://travis-ci.org/mlr-org/mlrMBO.png?branch=gh-pages)](https://travis-ci.org/mlr-org/mlrMBO) tutorial
- -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 - -mlrmbo-devel@googlegroups.com - -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.