From 174604d8b096556298f3a3ee12cc079211d947e0 Mon Sep 17 00:00:00 2001 From: qinyun-lin Date: Mon, 9 Dec 2024 17:08:46 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20konfound?= =?UTF-8?q?-project/konfound@ee77161b985a5d07a820f14db75792164f10e31e=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- articles/introduction-to-konfound.html | 2 +- pkgdown.yml | 2 +- reference/konfound.html | 22 ++++++++++++++++++++-- reference/output_print.html | 12 +++++++++++- search.json | 2 +- 5 files changed, 34 insertions(+), 6 deletions(-) diff --git a/articles/introduction-to-konfound.html b/articles/introduction-to-konfound.html index 90eb202..0fb29bf 100644 --- a/articles/introduction-to-konfound.html +++ b/articles/introduction-to-konfound.html @@ -61,7 +61,7 @@

Sarah Narvaiz, Qinyun Lin, Joshua M. Rosenberg, Kenneth A. Frank, Spiro Maroulis, Wei Wang, Ran Xu

-

2024-12-05

+

2024-12-09

Source: vignettes/introduction-to-konfound.Rmd
introduction-to-konfound.Rmd
diff --git a/pkgdown.yml b/pkgdown.yml index df5c188..343e016 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.1.1 pkgdown_sha: ~ articles: introduction-to-konfound: introduction-to-konfound.html -last_built: 2024-12-05T16:20Z +last_built: 2024-12-09T17:08Z urls: reference: https://konfound-it.org/konfound/reference article: https://konfound-it.org/konfound/articles diff --git a/reference/konfound.html b/reference/konfound.html index a5388fd..d7eb205 100644 --- a/reference/konfound.html +++ b/reference/konfound.html @@ -150,12 +150,30 @@

Exampleskonfound(m1, wt, to_return = "table") #> Dependent variable is mpg #> For interpretation, check out to_return = 'print'. +#> X represents wt, Y represents mpg, v represents each covariate. +#> First table is based on unconditional correlations, second table is based on +#> partial correlations. +#> +#> $Main_Output #> # A tibble: 3 × 6 #> term estimate std.error statistic p.value itcv #> <chr> <dbl> <dbl> <dbl> <dbl> <dbl> #> 1 (Intercept) 37.2 1.60 23.3 0 NA -#> 2 wt -3.88 0.633 -6.13 0 0.291 -#> 3 hp -0.032 0.009 -3.52 0.001 0.511 +#> 2 wt -3.88 0.633 -6.13 0 0.291 +#> 3 hp -0.032 0.009 -3.52 0.001 0.511 +#> +#> $Unconditional_Impact +#> # A tibble: 1 × 4 +#> term `Cor(vX)` `Cor(vY)` Impact +#> <chr> <dbl> <dbl> <dbl> +#> 1 hp 0.659 -0.776 -0.511 +#> +#> $Partial_Impact +#> # A tibble: 1 × 4 +#> term `Partial Cor(vX)` `Partial Cor(vY)` Partial_Impact +#> <chr> <dbl> <dbl> <dbl> +#> 1 hp 0.659 -0.776 -0.511 +#> # using glm() for non-linear models if (requireNamespace("forcats")) { diff --git a/reference/output_print.html b/reference/output_print.html index e208012..6d1c688 100644 --- a/reference/output_print.html +++ b/reference/output_print.html @@ -86,7 +86,9 @@

Usage rxcv = NA, rycv = NA, rxcvGz, - rycvGz + rycvGz, + benchmark_corr_product = NA, + itcv_ratio_to_benchmark = NA ) @@ -182,6 +184,14 @@

ArgumentsrycvGz

the correlation between outcome and CV necessary to nullify the inference for smallest impact, conditioning on all observed covariates.

+ +
benchmark_corr_product
+

the product of the correlations of covariates Z with X and Y (Rxz * Ryz), measuring the observed association strength.

+ + +
itcv_ratio_to_benchmark
+

the ratio of the ITCV to the benchmark_corr_product, indicating the robustness of inference.

+