Merge pull request #3 from CodeDepotIV/dev

Dev

CITATION.cff

@@ -5,7 +5,7 @@ authors:
     given-names: William
     orcid: https://orcid.org/0000-0001-7366-3903
 title: "sTabl3R: Quick Statistical Testing and Summary Tables in R"
-version: 0.5.0.1
+version: 0.6.0.0
 identifiers:
   - type: doi
     value: 10.5281/zenodo.12740946

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: sTabl3R
 Title: Quick Summary Statistics in R
-Version: 0.5.0.1
+Version: 0.6.0.0
 Authors@R: 
     person("William", "Ackerman", , "weackerm@uic.edu", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-7366-3903"))

NAMESPACE

@@ -4,6 +4,7 @@ S3method(summary,sTable)
 S3method(summary,ssTable)
 export(check_input)
 export(extract_stats)
+export(flag_high_cardinality)
 export(generate_results_tables)
 export(generate_statistics)
 import(flextable)

README.md

@@ -1,7 +1,7 @@
 # sTabl3R: Quick Statistical Testing and Summary Tables in R
 Quickly generate general statistical hypothesis tests and summary tables for demographic/phenotypic/clinical variables using a formatted data frame and a specified grouping variable. This project was motivated by a perceived need to accelerate data table production using some reasonable (albeit general) assumptions about the provided data.    
 
-In its current form, the package consists of a set of two major R functions to: (1) perform statistical analysis on a given data frame using a pre-specified grouping variable; and (2) generate tables using a combination of ``knitr::kable`` and ``flextable``. Some additional functions (≥ v0.5.0) are available to allow the user to access results more easily. See package documentation for additional details.
+In its current form, the package consists of a set of two major R functions to: (1) perform statistical analysis on a given data frame using a pre-specified grouping variable; and (2) generate tables using a combination of ``knitr::kable`` and ``flextable``. Some additional functions (≥ v0.5.0) are available to allow the user to access results more easily and quickly identify categorical variables that may need to be recoded. See package documentation for additional details.
 
 To install:
 The latest version can be found on [GitHub](https://github.com/CodeDepotIV/sTabl3R), and installed using `devtools`.
@@ -46,4 +46,7 @@ For categorical variables, the function will apply either the Chi-squared test o
 
 **FORMATTING:** The data frame should be an R ``data.frame()`` object in which the first column is a list of unique identifiers. The **group** argument should identify a column in the data frame that will be used to distinguish the groups that are to be compared statistically. *Please note* that if unique identifiers are not present in the first column, unique identifiers will be appended to the dataframe.
 
-The other functions include ``extract_stats()`` which allows the user to extract the statistical results for a variable of interest quickly, ``generate_results_tables()`` which generates a series of tables displaying all of the results generated following a call to ``generate_statistics()``, and ``summary()`` functions to show which variables in the user input were used in the analysis and how they were categorized.
+The other functions include ``extract_stats()`` which allows the user to extract the statistical results for a variable of interest quickly, ``generate_results_tables()`` which generates a series of tables displaying all of the results generated following a call to ``generate_statistics()``, and ``summary()`` functions to show which variables in the user input were used in the analysis and how they were categorized. 
+
+# New features as they arrive:
+**v0.6.0.0** Added ``flag_high_cardinality()`` function to scan a dataset for categorical variables that may require recoding.