cardx readme update

[ayogasekaram]

update readme with description

closes #105

Adding installation instructions, brief introduction and summary

---

Pre-review Checklist (if item does not apply, mark is as complete)

• All GitHub Action workflows pass with a ✅
• PR branch has pulled the most recent updates from master branch: usethis::pr_merge_main()
• If a bug was fixed, a unit test was added.
• If a new ard_*() function was added, it passes the ARD structural checks from cards::check_ard_structure().
• If a new ard_*() function was added, set_cli_abort_call() has been set.
• If a new ard_*() function was added and it depends on another package (such as, broom), is_pkg_installed("broom", reference_pkg = "cardx") has been set in the function call and the following added to the roxygen comments: @examplesIf do.call(asNamespace("cardx")$is_pkg_installed, list(pkg = "broom"", reference_pkg = "cardx"))
• Code coverage is suitable for any new functions/features (generally, 100% coverage for new code): devtools::test_coverage()

Reviewer Checklist (if item does not apply, mark is as complete)

• If a bug was fixed, a unit test was added.
• Code coverage is suitable for any new functions/features: devtools::test_coverage()

When the branch is ready to be merged:

• Update NEWS.md with the changes from this pull request under the heading "# cardx (development version)". If there is an issue associated with the pull request, reference it in parentheses at the end update (see NEWS.md for examples).
• All GitHub Action workflows pass with a ✅
• Approve Pull Request
• Merge the PR. Please use "Squash and merge" or "Rebase and merge".

[github-actions]

Code Coverage Summary

Filename                           Stmts    Miss  Cover    Missing
-------------------------------  -------  ------  -------  ------------------------------------
R/ard_aod_wald_test.R                 77       8  89.61%   36-41, 91, 94
R/ard_car_anova.R                     45       2  95.56%   62, 65
R/ard_car_vif.R                       61       2  96.72%   52, 86
R/ard_effectsize_cohens_d.R           88       2  97.73%   66, 111
R/ard_effectsize_hedges_g.R           82       2  97.56%   65, 115
R/ard_emmeans_mean_difference.R       70       0  100.00%
R/ard_proportion_ci.R                 42       5  88.10%   68-72
R/ard_regression_basic.R              16       1  93.75%   46
R/ard_regression.R                    51       0  100.00%
R/ard_smd_smd.R                       55       1  98.18%   48
R/ard_stats_anova.R                   95       0  100.00%
R/ard_stats_aov.R                     36       0  100.00%
R/ard_stats_chisq_test.R              39       1  97.44%   39
R/ard_stats_fisher_test.R             41       1  97.56%   39
R/ard_stats_kruskal_test.R            35       1  97.14%   38
R/ard_stats_mcnemar_test.R            79       2  97.47%   63, 105
R/ard_stats_mood_test.R               48       1  97.92%   46
R/ard_stats_oneway_test.R             31       0  100.00%
R/ard_stats_prop_test.R               82       1  98.78%   40
R/ard_stats_t_test.R                 110       2  98.18%   62, 108
R/ard_stats_wilcox_test.R             97       2  97.94%   62, 114
R/ard_survey_svychisq.R               37       1  97.30%   44
R/ard_survey_svycontinuous.R         193       2  98.96%   169, 179
R/ard_survey_svyranktest.R            51       0  100.00%
R/ard_survey_svyttest.R               50       0  100.00%
R/ard_survival_survdiff.R             89       0  100.00%
R/ard_survival_survfit.R             180       8  95.56%   79-81, 85, 95-97, 247
R/construction_helpers.R              57       6  89.47%   143, 155-159
R/proportion_ci.R                    194      28  85.57%   290, 293, 302-307, 315, 330, 431-454
TOTAL                               2131      79  96.29%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 0a4dd78

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   64 suites   10s ⏱️
 64 tests  44 ✅ 20 💤 0 ❌
181 runs  149 ✅ 32 💤 0 ❌

Results for commit 0a4dd78.

♻️ This comment has been updated with latest results.

[github-actions]

Unit Test Performance Difference

Test Suite	$Status$	Time on main	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
ard_emmeans_mean_difference	💀	$0.06$	$-0.06$	$-9$	$0$	$0$	$0$
construction_helpers	💀	$0.31$	$-0.31$	$-1$	$-1$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
ard_emmeans_mean_difference	💀	$0.06$	$-0.06$	ard_emmeans_mean_difference_works
ard_regression	💀	$0.01$	$-0.01$	ard_regression_does_not_produce_variable_level_column_where_not_applicable
ard_regression_basic	💀	$0.02$	$-0.02$	ard_regression_basic_does_not_produce_variable_level_column_where_not_applicable
construction_helpers	💀	$0.31$	$-0.31$	construct_model_works

Results for commit 8a771cf

♻️ This comment has been updated with latest results.

[ddsjoberg]

Thank you @ayogasekaram !! Can we make a couple small changes?

[github-actions]

CLA Assistant Lite bot ✅ All contributors have signed the CLA

[ayogasekaram]

I have read the CLA Document and I hereby sign the CLA

[ddsjoberg]

I have read the CLA Document and I hereby sign the CLA

[ddsjoberg]

thank you for making this cute!!