From 56d8367c18b3972a81c8cb0878f83b746dd13a7a Mon Sep 17 00:00:00 2001 From: User Name Date: Mon, 13 Nov 2023 09:03:08 +0200 Subject: [PATCH] update description and references --- DESCRIPTION | 7 ++++--- R/cfid-package.R | 9 ++++++--- README.Rmd | 6 +++--- README.md | 11 ++++++----- man/cfid-package.Rd | 8 ++++---- 5 files changed, 23 insertions(+), 18 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 59598a8..56a4c85 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -11,12 +11,13 @@ Authors@R: c( Maintainer: Santtu Tikka Description: Facilitates the identification of counterfactual queries in structural causal models via the ID* and IDC* algorithms - by Shpitser, I. and Pearl, J. (2007, 2008) - , . + by Shpitser, I. and Pearl, J. (2007, 2008) , + . Provides a simple interface for defining causal diagrams and counterfactual conjunctions. Construction of parallel worlds graphs and counterfactual graphs is carried out automatically based on the counterfactual query and the causal - diagram. See Tikka, S. (2022) for a tutorial of the package . + diagram. See Tikka, S. (2023) for a tutorial of + the package. License: GPL (>= 3) Encoding: UTF-8 URL: https://github.com/santikka/cfid diff --git a/R/cfid-package.R b/R/cfid-package.R index 05d77e5..0c82bbc 100644 --- a/R/cfid-package.R +++ b/R/cfid-package.R @@ -91,6 +91,11 @@ #' @docType package #' @name cfid-package #' @references +#' +#' Tikka, S. (2023). +#' Identifying counterfactual queries with the R package `cfid`. +#' *The R Journal*, **15(2)**:330--343. +#' #' Pearl, J. (1995) Causal diagrams for empirical research. *Biometrika*, #' **82(4)**:669--688. #' @@ -109,7 +114,5 @@ #' Survey on causal-based machine learning fairness notions. #' *arXiv:2010.09553* #' -#' Tikka, S. (2022). -#' Identifying counterfactual queries with the R package cfid. -#' *arXiv:2210.14745* + NULL diff --git a/README.Rmd b/README.Rmd index d7f976f..5ccb6fc 100644 --- a/README.Rmd +++ b/README.Rmd @@ -28,16 +28,16 @@ library(cfid) This package facilitates the identification of counterfactual queries in structural causal models via the ID* and IDC* algorithms by Shpitser, I. and Pearl, J. (2007, 2008) https://arxiv.org/abs/1206.5294, -https://jmlr.org/papers/v9/shpitser08a.html. Provides a simple interface for +https://jmlr.org/papers/v9/shpitser08a.html. A simple interface is provided for defining causal graphs and counterfactual conjunctions. Construction of parallel worlds graphs and counterfactual graphs is done automatically based on the counterfactual query and the causal graph. -See also the tutorial paper on this package: https://arxiv.org/abs/2210.14745 +For further information, see the tutorial paper on this package published in *The R Journal*: https://doi.org/10.32614/RJ-2023-053 ## Installation -Install the latest development version by using the devtools package: +You can install the latest development version by using the devtools package: ```{r, eval = FALSE} # install.packages("devtools") devtools::install_github("santikka/cfid") diff --git a/README.md b/README.md index c238e1a..9e691eb 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,18 @@ version](http://www.r-pkg.org/badges/version/cfid)](https://CRAN.R-project.org/p This package facilitates the identification of counterfactual queries in structural causal models via the ID\* and IDC\* algorithms by Shpitser, I. and Pearl, J. (2007, 2008) , -. Provides a simple -interface for defining causal graphs and counterfactual conjunctions. +. A simple interface is +provided for defining causal graphs and counterfactual conjunctions. Construction of parallel worlds graphs and counterfactual graphs is done automatically based on the counterfactual query and the causal graph. -See also the tutorial paper on this package: - +For further information, see the tutorial paper on this package +published in *The R Journal*: ## Installation -Install the latest development version by using the devtools package: +You can install the latest development version by using the devtools +package: ``` r # install.packages("devtools") diff --git a/man/cfid-package.Rd b/man/cfid-package.Rd index 696947b..c126f51 100644 --- a/man/cfid-package.Rd +++ b/man/cfid-package.Rd @@ -95,6 +95,10 @@ For complete examples of identifiable counterfactual queries, see } \references{ +Tikka, S. (2023). +Identifying counterfactual queries with the R package \code{cfid}. +\emph{The R Journal}, \strong{15(2)}:330--343. + Pearl, J. (1995) Causal diagrams for empirical research. \emph{Biometrika}, \strong{82(4)}:669--688. @@ -112,8 +116,4 @@ methods for the causal hierarchy. \emph{Journal of Machine Learning Research}, Makhlouf, K., Zhioua, S. and Palamidessi, C. (2021). Survey on causal-based machine learning fairness notions. \emph{arXiv:2010.09553} - -Tikka, S. (2022). -Identifying counterfactual queries with the R package cfid. -\emph{arXiv:2210.14745} }