Skip to content

Commit e82649c

Browse files
committed
docs: update readme
docs: more readme changes docs: more changes docs: more badges
1 parent 31827c2 commit e82649c

File tree

1 file changed

+24
-36
lines changed

1 file changed

+24
-36
lines changed

README.md

Lines changed: 24 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,28 @@
1-
FDboost
2-
======
1+
# FDboost
32

4-
[![Build Status (Linux)](https://travis-ci.org/boost-R/FDboost.svg?branch=master)](https://travis-ci.org/boost-R/FDboost)
5-
<!--[![Build status (Windows)](https://ci.appveyor.com/api/projects/status/5mkvicgin1j6pfc6/branch/master?svg=true)](https://ci.appveyor.com/project/hofnerb/mboost-h73a1/branch/master) -->
6-
[![CRAN Status Badge](https://www.r-pkg.org/badges/version/FDboost)](https://cran.r-project.org/package=FDboost)
7-
<!--[![Coverage Status](https://coveralls.io/repos/github/boost-R/mboost/badge.svg?branch=master)](https://coveralls.io/github/boost-R/mboost?branch=master) -->
8-
[![](https://cranlogs.r-pkg.org/badges/FDboost)](https://cran.rstudio.com/web/packages/FDboost/index.html)
3+
<!-- badges: start -->
4+
5+
[![CRAN status](https://www.r-pkg.org/badges/version/FDboost)](https://CRAN.R-project.org/package=FDboost)
6+
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/FDboost)](https://www.r-pkg.org/pkg/FDboost)
7+
8+
<!-- badges: end -->
99

1010
`FDboost` Boosting Functional Regression Models.
1111

12-
The package FDboost fits regression models for functional data, i.e.,
12+
The package FDboost fits regression models for functional data, i.e.,
1313
scalar-on-function, function-on-scalar, and function-on-function regression models,
14-
by a component-wise gradient boosting algorithm.
14+
by a component-wise gradient boosting algorithm.
1515
Furthermore, it can be used to fit density-on-scalar regression models.
1616

1717
## Using FDboost
1818

1919
For installation instructions see below.
2020

2121
Instructions on how to use `FDboost` can be found in various places:
22+
2223
- Read the tutorial paper [doi:10.18637/jss.v094.i10](doi:10.18637/jss.v094.i10)
2324
- Have a look at the manual, which also contains example code
24-
- Check the vignettes:
25+
- Check the vignettes:
2526
- [function-on-function regression](https://cran.r-project.org/web/packages/FDboost/vignettes/FLAM_canada.pdf)
2627
- [scalar-on-function regression](https://cran.r-project.org/web/packages/FDboost/vignettes/FLAM_fuel.pdf)
2728
- [function-on-scalar regression](https://cran.r-project.org/web/packages/FDboost/vignettes/FLAM_viscosity.pdf)
@@ -31,30 +32,17 @@ Instructions on how to use `FDboost` can be found in various places:
3132

3233
For issues, bugs, feature requests etc. please use the [GitHub Issues](https://github.com/boost-R/FDboost/issues).
3334

34-
## Installation Instructions
35-
36-
- Current version (from CRAN):
37-
```r
38-
install.packages("FDboost")
39-
```
40-
41-
- Latest **patch version** (patched version of CRAN package; under development) from GitHub:
42-
```r
43-
library("devtools")
44-
install_github("boost-R/FDboost")
45-
library("FDboost")
46-
```
47-
48-
<!-- - Latest **development version** (version with new features; under development) from GitHub:
49-
```r
50-
library("devtools")
51-
install_github("boost-R/mboost", ref = "devel")
52-
library("mboost")
53-
```
54-
-->
55-
56-
To be able to use the `install_github()` command, one needs to install `devtools` first:
57-
```r
58-
install.packages("devtools")
59-
```
35+
## Installation
36+
37+
Install the last release from [CRAN](https://cran.r-project.org):
38+
39+
```r
40+
install.packages("FDboost")
41+
```
42+
43+
Install the development version from [GitHub](https://github.com/):
6044

45+
```r
46+
# install.packages("pak")
47+
pak::pak("boost-R/FDboost")
48+
```

0 commit comments

Comments
 (0)