updated readme

xiaodaigh · Nov 19, 2019 · d892021 · d892021 · xiaodaigh · Nov 19, 2019
1 parent e05fe01
commit d892021
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 8 deletions.
diff --git a/Project.toml b/Project.toml
@@ -15,7 +15,12 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 WeakRefStrings = "ea10d353-3f73-51f8-a26c-33c1cb351aa5"
 
 [compat]
+CategoricalArrays = "0.7.2"
 DataFrames = "0.19"
+Missings = "0.4"
+SortingLab = "0.2"
+StatsBase = "0.32"
+WeakRefStrings = "0.6"
 julia = "1"
 
 [extras]

diff --git a/README.md b/README.md
@@ -1,11 +1,24 @@
 # DataConvenience
 
-## Corelations
+An eclectic collection of convenience functions for you.
+
+## Data
+
+### `cleannames!`
+Somewhat similiar to R's `janitor::clean_names` so that `cleannames!(df)` cleans the names of a `DataFrame`.
+
+## Statistics & Correlations
+
+### Canonical Correlation
+The first component of Canonical Correlation.
+
+```
+canonicalcor(x, y)
+```
 
 ### Correlation for `Bool`
 `cor(x::Bool, y)` -  allow you to treat `Bool` as 0/1 when computing correlation
 
-
 ### Correlation for `DataFrames`
 `dfcor(df::AbstractDataFrame, cols1=names(df), cols2=names(df), verbose=false)`
 
@@ -15,15 +28,12 @@ will be computed
 
 ## Miscellaneous
 
-### `cleannames!`
-Borrowed R's `janitor::clean_names` so that `cleannames!(df)` cleans the names of a `DataFrame`
-
-### StringVector
-`StringVector(v::CategoricalVector{String})` - Convert `v::CategoricalVector` efficiently to WeakRefStrings.StringVector
-
 ### `@replicate`
 `@replicate code times` will run `code` multiple times e.g.
 
 ```julia
 @replicate 10 randstring(8)
 ```
+
+### StringVector
+`StringVector(v::CategoricalVector{String})` - Convert `v::CategoricalVector` efficiently to WeakRefStrings.StringVector