Skip to content

Commit

Permalink
Merge pull request #187 from DoubleML/p-upd-logo
Browse files Browse the repository at this point in the history
Update of R API docu: New logo and theme
  • Loading branch information
PhilippBach authored Jun 15, 2023
2 parents 8133fa8 + 606659a commit ba452ab
Show file tree
Hide file tree
Showing 13 changed files with 44 additions and 42 deletions.
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Documentation of functions in R: [https://docs.doubleml.org/r/stable/reference/i

User guide: [https://docs.doubleml.org](https://docs.doubleml.org)

**DoubleML** is currently maintained by [`@MalteKurz`](https://github.com/MalteKurz) and [`@PhilippBach`](https://github.com/PhilippBach).
**DoubleML** is currently maintained by [`@PhilippBach`](https://github.com/PhilippBach) and [`@SvenKlaassen`](https://github.com/SvenKlaassen).

## Main Features

Expand Down
81 changes: 40 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ Documentation of functions in R:
User guide: <https://docs.doubleml.org>

**DoubleML** is currently maintained by
[`@MalteKurz`](https://github.com/MalteKurz) and
[`@PhilippBach`](https://github.com/PhilippBach).
[`@PhilippBach`](https://github.com/PhilippBach) and
[`@SvenKlaassen`](https://github.com/SvenKlaassen).

## Main Features

Double / debiased machine learning framework of [Chernozhukov et
al. (2018)](https://arxiv.org/abs/1608.00060) for

- Partially linear regression models (PLR)
- Partially linear IV regression models (PLIV)
- Interactive regression models (IRM)
- Interactive IV regression models (IIVM)
- Partially linear regression models (PLR)
- Partially linear IV regression models (PLIV)
- Interactive regression models (IRM)
- Interactive IV regression models (IIVM)

The object-oriented implementation of **DoubleML** that is based on the
[R6 package for R](https://r6.r-lib.org/) is very flexible. The model
Expand All @@ -55,20 +55,20 @@ learning models and to perform statistical inference via the methods
object-oriented implementation allows a high flexibility for the model
specification in terms of …

- … the machine learning methods for estimation of the nuisance
functions,
- … the resampling schemes,
- … the double machine learning algorithm,
- … the Neyman orthogonal score functions,
-
- … the machine learning methods for estimation of the nuisance
functions,
- … the resampling schemes,
- … the double machine learning algorithm,
- … the Neyman orthogonal score functions,
-

It further can be readily extended with regards to

- … new model classes that come with Neyman orthogonal score functions
being linear in the target parameter,
- … alternative score functions via callables,
- … alternative resampling schemes,
-
- … new model classes that come with Neyman orthogonal score functions
being linear in the target parameter,
- … alternative score functions via callables,
- … alternative resampling schemes,
-

![OOP structure of the DoubleML package](man/figures/oop.svg?raw=true)

Expand All @@ -88,18 +88,18 @@ remotes::install_github("DoubleML/doubleml-for-r")

**DoubleML** requires

- R (\>= 3.5.0)
- R6 (\>= 2.4.1)
- data.table (\>= 1.12.8)
- stats
- checkmate
- mlr3 (\>= 0.5.0)
- mlr3tuning (\>= 0.3.0)
- mlr3learners (\>= 0.3.0)
- mvtnorm
- utils
- clusterGeneration
- readstata13
- R (\>= 3.5.0)
- R6 (\>= 2.4.1)
- data.table (\>= 1.12.8)
- stats
- checkmate
- mlr3 (\>= 0.5.0)
- mlr3tuning (\>= 0.3.0)
- mlr3learners (\>= 0.3.0)
- mvtnorm
- utils
- clusterGeneration
- readstata13

## Contributing

Expand Down Expand Up @@ -137,17 +137,16 @@ Foundation) is acknowledged – Project Number 431701914.

## References

- Bach, P., Chernozhukov, V., Kurz, M. S., and Spindler, M. (2021),
DoubleML - An Object-Oriented Implementation of Double Machine
Learning in R, arXiv:[2103.09603](https://arxiv.org/abs/2103.09603).
- Bach, P., Chernozhukov, V., Kurz, M. S., and Spindler, M. (2021),
DoubleML - An Object-Oriented Implementation of Double Machine
Learning in R, arXiv:[2103.09603](https://arxiv.org/abs/2103.09603).

- Chernozhukov, V., Chetverikov, D., Demirer, M., Duflo, E., Hansen,
C., Newey, W. and Robins, J. (2018), Double/debiased machine
learning for treatment and structural parameters. The Econometrics
Journal, 21: C1-C68, <https://doi.org/10.1111/ectj.12097>.
- Chernozhukov, V., Chetverikov, D., Demirer, M., Duflo, E., Hansen, C.,
Newey, W. and Robins, J. (2018), Double/debiased machine learning for
treatment and structural parameters. The Econometrics Journal, 21:
C1-C68, <https://doi.org/10.1111/ectj.12097>.

- Lang, M., Binder, M., Richter, J., Schratz, P., Pfisterer, F.,
Coors, S., Au, Q., Casalicchio, G., Kotthoff, L., Bischl, B. (2019),
mlr3: A modern object-oriented machine learing framework in R.
Journal of Open Source Software,
<https://doi.org/10.21105/joss.01903>.
- Lang, M., Binder, M., Richter, J., Schratz, P., Pfisterer, F., Coors,
S., Au, Q., Casalicchio, G., Kotthoff, L., Bischl, B. (2019), mlr3: A
modern object-oriented machine learing framework in R. Journal of Open
Source Software, <https://doi.org/10.21105/joss.01903>.
3 changes: 3 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ development:
toc:
depth: 3

template:
bootstrap: 5

navbar:
structure:
left: [home, userguide, getstarted, reference, articles]
Expand Down
Binary file modified man/figures/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-120x120.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-152x152.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-180x180.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-60x60.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-76x76.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon.ico
Binary file not shown.

0 comments on commit ba452ab

Please sign in to comment.