update description and references

DESCRIPTION

@@ -11,12 +11,13 @@ Authors@R: c(
 Maintainer: Santtu Tikka <santtuth@gmail.com>
 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) 
- <arXiv:1206.5294>, <https://jmlr.org/papers/v9/shpitser08a.html>. 
+ by Shpitser, I. and Pearl, J. (2007, 2008) <arXiv:1206.5294>, 
+ <https://jmlr.org/papers/v9/shpitser08a.html>. 
  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 <arXiv:2210.14745>.
+ diagram. See Tikka, S. (2023) <doi:10.32614/RJ-2023-053> for a tutorial of 
+ the package.
 License: GPL (>= 3)
 Encoding: UTF-8
 URL: https://github.com/santikka/cfid

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

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")

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) <https://arxiv.org/abs/1206.5294>,
-<https://jmlr.org/papers/v9/shpitser08a.html>. Provides a simple
-interface for defining causal graphs and counterfactual conjunctions.
+<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
 # install.packages("devtools")