Skip to content

Commit

Permalink
update after CRAN release
Browse files Browse the repository at this point in the history
  • Loading branch information
nhejazi committed Mar 6, 2020
1 parent 52f65b8 commit c670f3d
Show file tree
Hide file tree
Showing 8 changed files with 90 additions and 94 deletions.
2 changes: 0 additions & 2 deletions CRAN-RELEASE

This file was deleted.

18 changes: 9 additions & 9 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ knitr::opts_chunk$set(
[![Travis-CI Build Status](https://travis-ci.org/tlverse/hal9001.svg?branch=master)](https://travis-ci.org/tlverse/hal9001)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/jeremyrcoyle/hal9001?branch=master&svg=true)](https://ci.appveyor.com/project/jeremyrcoyle/hal9001)
[![Coverage Status](https://img.shields.io/codecov/c/github/tlverse/hal9001/master.svg)](https://codecov.io/github/tlverse/hal9001?branch=master)
[![CRAN](http://www.r-pkg.org/badges/version/hal9001)](http://www.r-pkg.org/pkg/hal9001)
[![CRAN downloads](https://cranlogs.r-pkg.org/badges/hal9001)](https://CRAN.R-project.org/package=hal9001)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3558314.svg)](https://doi.org/10.5281/zenodo.3558314)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3558313.svg)](https://doi.org/10.5281/zenodo.3558313)

> The _Scalable_ Highly Adaptive Lasso
Expand Down Expand Up @@ -53,20 +55,18 @@ recent works.

## Installation

<!--
For standard use, we recommend installing the package from
[CRAN](https://cran.r-project.org/) via
[CRAN](https://CRAN.R-project.org/package=hal9001) via

```{r cran-installation, eval = FALSE}
install.packages("hal9001")
```
-->

To contribute, install the _development version_ of `hal9001` from GitHub via
[`remotes`](https://CRAN.R-project.org/package=remotes):

```{r gh-master-installation, eval = FALSE}
remotes::install_github("tlverse/hal9001", build_vignettes = FALSE)
remotes::install_github("tlverse/hal9001")
```

---
Expand All @@ -85,11 +85,11 @@ the Highly Adaptive Lasso. For details on the properties of the estimator, the
interested reader is referred to @benkeser2016hal and @vdl2017generally.

```{r example}
# load the hal9001 package
# load the package and set a seed
library(hal9001)
set.seed(385971)
# simulate data
set.seed(385971)
n <- 100
p <- 3
x <- xmat <- matrix(rnorm(n * p), n, p)
Expand Down Expand Up @@ -126,8 +126,8 @@ After using the `hal9001` R package, please cite the following:
year = {2019},
howpublished = {\url{https://github.com/tlverse/hal9001}},
note = {{R} package version 0.2.5},
url = {https://doi.org/10.5281/zenodo.3558314},
doi = {10.5281/zenodo.3558314}
url = {https://doi.org/10.5281/zenodo.3558313},
doi = {10.5281/zenodo.3558313}
}

---
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@ Status](https://travis-ci.org/tlverse/hal9001.svg?branch=master)](https://travis
Status](https://ci.appveyor.com/api/projects/status/github/jeremyrcoyle/hal9001?branch=master&svg=true)](https://ci.appveyor.com/project/jeremyrcoyle/hal9001)
[![Coverage
Status](https://img.shields.io/codecov/c/github/tlverse/hal9001/master.svg)](https://codecov.io/github/tlverse/hal9001?branch=master)
[![CRAN](http://www.r-pkg.org/badges/version/hal9001)](http://www.r-pkg.org/pkg/hal9001)
[![CRAN
downloads](https://cranlogs.r-pkg.org/badges/hal9001)](https://CRAN.R-project.org/package=hal9001)
[![Project Status: Active – The project has reached a stable, usable
state and is being actively
developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
[![License: GPL
v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3558314.svg)](https://doi.org/10.5281/zenodo.3558314)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3558313.svg)](https://doi.org/10.5281/zenodo.3558313)

> The *Scalable* Highly Adaptive Lasso
Expand Down Expand Up @@ -47,21 +50,18 @@ consider consulting Benkeser and van der Laan (2016), van der Laan

## Installation

<!--
For standard use, we recommend installing the package from
[CRAN](https://cran.r-project.org/) via
[CRAN](https://CRAN.R-project.org/package=hal9001) via

```r
``` r
install.packages("hal9001")
```
-->

To contribute, install the *development version* of `hal9001` from
GitHub via [`remotes`](https://CRAN.R-project.org/package=remotes):

``` r
remotes::install_github("tlverse/hal9001", build_vignettes = FALSE)
remotes::install_github("tlverse/hal9001")
```

-----
Expand All @@ -81,13 +81,13 @@ estimator, the interested reader is referred to Benkeser and van der
Laan (2016) and van der Laan (2017a).

``` r
# load the hal9001 package
# load the package and set a seed
library(hal9001)
#> Loading required package: Rcpp
#> hal9001 v0.2.5: The Scalable Highly Adaptive Lasso
set.seed(385971)

# simulate data
set.seed(385971)
n <- 100
p <- 3
x <- xmat <- matrix(rnorm(n * p), n, p)
Expand All @@ -98,12 +98,12 @@ hal_fit <- fit_hal(X = x, Y = y)
#> [1] "I'm sorry, Dave. I'm afraid I can't do that."
hal_fit$times
#> user.self sys.self elapsed user.child sys.child
#> enumerate_basis 0.002 0.00 0.001 0 0
#> design_matrix 0.001 0.00 0.002 0 0
#> remove_duplicates 0.005 0.00 0.004 0 0
#> reduce_basis 0.000 0.00 0.000 0 0
#> lasso 0.226 0.02 0.247 0 0
#> total 0.234 0.02 0.254 0 0
#> enumerate_basis 0.005 0.000 0.006 0 0
#> design_matrix 0.005 0.000 0.005 0 0
#> remove_duplicates 0.017 0.000 0.017 0 0
#> reduce_basis 0.000 0.000 0.000 0 0
#> lasso 0.261 0.005 0.270 0 0
#> total 0.288 0.005 0.298 0 0

# training sample prediction
preds <- predict(hal_fit, new_data = x)
Expand Down Expand Up @@ -134,8 +134,8 @@ After using the `hal9001` R package, please cite the following:
year = {2019},
howpublished = {\url{https://github.com/tlverse/hal9001}},
note = {{R} package version 0.2.5},
url = {https://doi.org/10.5281/zenodo.3558314},
doi = {10.5281/zenodo.3558314}
url = {https://doi.org/10.5281/zenodo.3558313},
doi = {10.5281/zenodo.3558313}
}
```

Expand Down
42 changes: 21 additions & 21 deletions docs/articles/intro_hal9001.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit c670f3d

Please sign in to comment.