[Mboost-commits] r845 - /

[noreply at r-forge.r-project.org]

Author: hofner
Date: 2015-04-15 10:36:55 +0200 (Wed, 15 Apr 2015)
New Revision: 845

Added:
   .travis.yml
   README.md
Log:
added README and integrated support for travis-ci on github

Added: .travis.yml
===================================================================
--- .travis.yml	                        (rev 0)
+++ .travis.yml	2015-04-15 08:36:55 UTC (rev 845)
@@ -0,0 +1,22 @@
+## check development version of mboost
+## see http://docs.travis-ci.com/user/languages/r/
+
+language: r
+
+sudo: required
+
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install latex-xcolor
+  - cd pkg/mboostDevel
+
+r_github_packages:
+  - hofnerb/stabs
+  
+after_failure:
+  - ./travis-tool.sh dump_logs
+
+notifications:
+  email:
+    on_success: change
+    on_failure: change

Added: README.md
===================================================================
--- README.md	                        (rev 0)
+++ README.md	2015-04-15 08:36:55 UTC (rev 845)
@@ -0,0 +1,54 @@
+mboost
+======
+
+[![Build Status](https://travis-ci.org/hofnerb/mboost.svg?branch=travis-ci)](https://travis-ci.org/hofnerb/mboost)
+
+`mboost` implements boosting algorithms for fitting generalized linear, additive and interaction models 
+to potentially high-dimensional data. 
+
+This [github repositiry](https://github.com/hofnerb/mboost) is just a copy of the r-forge repository which is hosted at 
+[R-forge](https://r-forge.r-project.org/projects/mboost).
+
+## Installation
+
+- Current version (from CRAN): 
+  ```
+  install.packages("mboost")
+  ```
+
+- Latest **patch version** (under development) from GitHub:
+  ```
+  library("devtools")
+  install_github("hofnerb/mboost/pkg/mboostPatch")
+  library("mboost")
+  ```
+
+- Latest **development version** from GitHub:
+  ```
+  library("devtools")
+  install_github("hofnerb/mboost/pkg/mboostDevel")
+  library("mboostDevel")
+  ```
+
+  To be able to use the `install_github()` command, one needs to install `devtools` first:
+  ```
+  install.packages("devtools")
+  ```
+
+- Alternatively, both the current patch and development versions of `mboost` (or `mboostDevel` respectively) 
+  can be downloaded from R-forge if the built was successfull:
+  ```
+  install.packages("mboost", repos = "http://r-forge.r-project.org")
+  ## or
+  install.packages("mboostDevel", repos = "http://r-forge.r-project.org")
+  ```
+  However, currently these builts often don't succeed and furthemore are only available 
+  for recent versions of R.
+  
+## Using mboost
+
+Instructions on how to use `mboost` can be found in various places:
+- Have a look at the tutorials:
+  - [mboost tutorial](http://cran.r-project.org/web/packages/mboost/vignettes/mboost_tutorial.pdf)
+  - [mboost 2.0](http://cran.r-project.org/web/packages/mboost/vignettes/mboost.pdf)
+- Visit the [project homepage](http://mboost.r-forge.r-project.org/) and see further tutorials and references there.