Merge branch 'main' of github.com:DoubleML/doubleml-for-r into store-models

MalteKurz · MalteKurz · commit 4f727a474862 · 2022-11-04T14:11:56.000+01:00
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,5 @@
 Thanks for contributing to DoubleML.
-Before submitting a PR, please take a look at our [contribution guidelines](https://github.com/DoubleML/doubleml-for-r/blob/master/CONTRIBUTING.md).
+Before submitting a PR, please take a look at our [contribution guidelines](https://github.com/DoubleML/doubleml-for-r/blob/main/CONTRIBUTING.md).
 Additionally, please fill out the PR checklist below.
 
 ### Description
@@ -14,11 +14,11 @@ Here you can add further comments.
 You can also delete this section, if it is not necessary.
 
 ### PR Checklist
-Please fill out this PR checklist (see our [contributing guidelines](https://github.com/DoubleML/doubleml-for-r/blob/master/CONTRIBUTING.md#checklist-for-pull-requests-pr) for details).
+Please fill out this PR checklist (see our [contributing guidelines](https://github.com/DoubleML/doubleml-for-r/blob/main/CONTRIBUTING.md#checklist-for-pull-requests-pr) for details).
 
 - [ ] The title of the pull request summarizes the changes made.
 - [ ] The PR contains a detailed description of all changes and additions.
 - [ ] References to related issues or PRs are added.
-- [ ] The code passes `R CMD check` and all (unit) tests (see our [contributing guidelines](https://github.com/DoubleML/doubleml-for-r/blob/master/CONTRIBUTING.md#checklist-for-pull-requests-pr) for details).
+- [ ] The code passes `R CMD check` and all (unit) tests (see our [contributing guidelines](https://github.com/DoubleML/doubleml-for-r/blob/main/CONTRIBUTING.md#checklist-for-pull-requests-pr) for details).
 - [ ] Enhancements or new feature are equipped with unit tests.
-- [ ] The changes adhere to the "mlr-style" standards (see our [contributing guidelines](https://github.com/DoubleML/doubleml-for-r/blob/master/CONTRIBUTING.md#checklist-for-pull-requests-pr) for details).
+- [ ] The changes adhere to the "mlr-style" standards (see our [contributing guidelines](https://github.com/DoubleML/doubleml-for-r/blob/main/CONTRIBUTING.md#checklist-for-pull-requests-pr) for details).
diff --git a/.github/workflows/check_styler.yml b/.github/workflows/check_styler.yml
@@ -4,10 +4,10 @@ name: Check style guidelines
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
   schedule:
     - cron: "0 9 * * 1,3,5"
   workflow_dispatch:
diff --git a/.github/workflows/deploy_docu.yml b/.github/workflows/deploy_docu.yml
@@ -5,7 +5,7 @@ name: CI deploy documentation
 on:
   push:
     branches:
-      - master
+      - main
   workflow_dispatch:
   release:
     types:
@@ -80,7 +80,7 @@ jobs:
       uses: JamesIves/github-pages-deploy-action@3.7.1
       with:
         REPOSITORY_NAME: DoubleML/doubleml.github.io
-        BRANCH: master
+        BRANCH: main
         FOLDER: docs/dev
         TARGET_FOLDER: r/dev
         GIT_CONFIG_NAME: DoubleML Deploy Bot
@@ -96,7 +96,7 @@ jobs:
       uses: JamesIves/github-pages-deploy-action@3.7.1
       with:
         REPOSITORY_NAME: DoubleML/doubleml.github.io
-        BRANCH: master
+        BRANCH: main
         FOLDER: docs/dev
         TARGET_FOLDER: r/${{env.RELEASE_VERSION}}
         GIT_CONFIG_NAME: DoubleML Deploy Bot
@@ -109,7 +109,7 @@ jobs:
       uses: JamesIves/github-pages-deploy-action@3.7.1
       with:
         REPOSITORY_NAME: DoubleML/doubleml.github.io
-        BRANCH: master
+        BRANCH: main
         FOLDER: docs/dev
         TARGET_FOLDER: r/stable
         GIT_CONFIG_NAME: DoubleML Deploy Bot
diff --git a/.github/workflows/rcheck.yml b/.github/workflows/rcheck.yml
@@ -4,10 +4,10 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
   schedule:
     - cron: "0 9 * * 1,3,5"
   workflow_dispatch:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,7 +3,7 @@
 DoubleML is a community effort.
 Everyone is welcome to contribute.
 All contributors should adhere to this contributing guidelines
-and our [code of conduct](https://github.com/DoubleML/doubleml-for-r/blob/master/CODE_OF_CONDUCT.md).
+and our [code of conduct](https://github.com/DoubleML/doubleml-for-r/blob/main/CODE_OF_CONDUCT.md).
 The contributing guidelines are particularly helpful to get started for your first contribution.
 
 ## Submit a Bug Report :bug:
@@ -75,7 +75,7 @@ $ git remote add upstream https://github.com/DoubleML/doubleml-for-r.git
 This allows you to easily keep your repository in synch via
 ```bash
 $ git fetch upstream
-$ git merge upstream/master
+$ git merge upstream/main
 ```
 
 5. **Develop** your code changes. A helpful resource for package development in R
@@ -162,7 +162,7 @@ Furthermore, the **score components for the Neyman orthogonal score function nee
 All other functionality is automatically available via inheritance from the abstract base class.
 <!---TODO: Add a model template for the R package DoubleML
 A **template for new model classes** is available
-[here](https://github.com/DoubleML/doubleml-docs/blob/master/model_templates/double_ml_model_template.py).--->
+[here](https://github.com/DoubleML/doubleml-docs/blob/main/model_templates/double_ml_model_template.py).--->
 
 ## Contribute Documentation :books:
 
diff --git a/README.Rmd b/README.Rmd
@@ -8,7 +8,7 @@ output: github_document
 
 
 [![build](https://github.com/DoubleML/doubleml-for-r/workflows/build/badge.svg)](https://github.com/DoubleML/doubleml-for-r/actions?query=workflow%3Abuild)
-[![codecov](https://codecov.io/gh/DoubleML/doubleml-for-r/branch/master/graph/badge.svg?token=C5aiyo2MVL)](https://app.codecov.io/gh/DoubleML/doubleml-for-r/)
+[![codecov](https://codecov.io/gh/DoubleML/doubleml-for-r/branch/main/graph/badge.svg?token=C5aiyo2MVL)](https://app.codecov.io/gh/DoubleML/doubleml-for-r/)
 [![CodeFactor](https://www.codefactor.io/repository/github/doubleml/doubleml-for-r/badge)](https://www.codefactor.io/repository/github/doubleml/doubleml-for-r)
 [![CRAN Version](https://www.r-pkg.org/badges/version/DoubleML)](https://cran.r-project.org/package=DoubleML)
 
@@ -84,9 +84,9 @@ remotes::install_github("DoubleML/doubleml-for-r")
 DoubleML is a community effort.
 Everyone is welcome to contribute.
 To get started for your first contribution we recommend reading our
-[contributing guidelines](https://github.com/DoubleML/doubleml-for-r/blob/master/CONTRIBUTING.md)
+[contributing guidelines](https://github.com/DoubleML/doubleml-for-r/blob/main/CONTRIBUTING.md)
 and our
-[code of conduct](https://github.com/DoubleML/doubleml-for-r/blob/master/CODE_OF_CONDUCT.md).
+[code of conduct](https://github.com/DoubleML/doubleml-for-r/blob/main/CODE_OF_CONDUCT.md).
 
 ## Citation
 
@@ -110,8 +110,15 @@ Bibtex-entry:
 }
 ```
 
+## Acknowledgements
+
+Funding by the Deutsche Forschungsgemeinschaft (DFG, German Research
+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). 
+
 * 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>.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 # DoubleML - Double Machine Learning in R <a href="https://docs.doubleml.org"><img src="man/figures/logo.png" align="right" width = "120" /></a>
 
 [![build](https://github.com/DoubleML/doubleml-for-r/workflows/build/badge.svg)](https://github.com/DoubleML/doubleml-for-r/actions?query=workflow%3Abuild)
-[![codecov](https://codecov.io/gh/DoubleML/doubleml-for-r/branch/master/graph/badge.svg?token=C5aiyo2MVL)](https://app.codecov.io/gh/DoubleML/doubleml-for-r/)
+[![codecov](https://codecov.io/gh/DoubleML/doubleml-for-r/branch/main/graph/badge.svg?token=C5aiyo2MVL)](https://app.codecov.io/gh/DoubleML/doubleml-for-r/)
 [![CodeFactor](https://www.codefactor.io/repository/github/doubleml/doubleml-for-r/badge)](https://www.codefactor.io/repository/github/doubleml/doubleml-for-r)
 [![CRAN
 Version](https://www.r-pkg.org/badges/version/DoubleML)](https://cran.r-project.org/package=DoubleML)
@@ -88,14 +88,14 @@ remotes::install_github("DoubleML/doubleml-for-r")
 
 **DoubleML** requires
 
--   R (&gt;= 3.5.0)
--   R6 (&gt;= 2.4.1)
--   data.table (&gt;= 1.12.8)
+-   R (\>= 3.5.0)
+-   R6 (\>= 2.4.1)
+-   data.table (\>= 1.12.8)
 -   stats
 -   checkmate
--   mlr3 (&gt;= 0.5.0)
--   mlr3tuning (&gt;= 0.3.0)
--   mlr3learners (&gt;= 0.3.0)
+-   mlr3 (\>= 0.5.0)
+-   mlr3tuning (\>= 0.3.0)
+-   mlr3learners (\>= 0.3.0)
 -   mvtnorm
 -   utils
 -   clusterGeneration
@@ -106,9 +106,9 @@ remotes::install_github("DoubleML/doubleml-for-r")
 DoubleML is a community effort. Everyone is welcome to contribute. To
 get started for your first contribution we recommend reading our
 [contributing
-guidelines](https://github.com/DoubleML/doubleml-for-r/blob/master/CONTRIBUTING.md)
+guidelines](https://github.com/DoubleML/doubleml-for-r/blob/main/CONTRIBUTING.md)
 and our [code of
-conduct](https://github.com/DoubleML/doubleml-for-r/blob/master/CODE_OF_CONDUCT.md).
+conduct](https://github.com/DoubleML/doubleml-for-r/blob/main/CODE_OF_CONDUCT.md).
 
 ## Citation
 
@@ -130,8 +130,17 @@ Bibtex-entry:
           note={arXiv:\href{https://arxiv.org/abs/2103.09603}{2103.09603} [stat.ML]}
     }
 
+## Acknowledgements
+
+Funding by the Deutsche Forschungsgemeinschaft (DFG, German Research
+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).
+
 -   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
diff --git a/tests/testthat/test-double_ml_irm_binary_outcome.R b/tests/testthat/test-double_ml_irm_binary_outcome.R
@@ -13,7 +13,7 @@ if (on_cran) {
     trimming_threshold = 0,
     stringsAsFactors = FALSE
   )
-  test_cases["test_name"] = apply(test_cases, 1, paste, collapse = "_")
+  test_cases[".test_name"] = apply(test_cases, 1, paste, collapse = "_")
 } else {
   test_cases = expand.grid(
     learner = "cv_glmnet",

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ if (on_cran) {`
`13`	`13`	`trimming_threshold = 0,`
`14`	`14`	`stringsAsFactors = FALSE`
`15`	`15`	`)`
`16`		`- test_cases["test_name"] = apply(test_cases, 1, paste, collapse = "_")`
	`16`	`+ test_cases[".test_name"] = apply(test_cases, 1, paste, collapse = "_")`
`17`	`17`	`} else {`
`18`	`18`	`test_cases = expand.grid(`
`19`	`19`	`learner = "cv_glmnet",`