Update version (#198)

* Update docstring * Update version
bcbi · Mar 13, 2023 · 392743e · 392743e · AshlinHarris · Mar 13, 2023
1 parent d298a3e
commit 392743e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "PreprocessMD"
 uuid = "f785c8c6-3d80-4813-989a-2eb5f27d6bef"
 authors = ["Ashlin Harris <[email protected]>"]
-version = "3.1.0"
+version = "3.1.1"
 
 [deps]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"

diff --git a/src/PreprocessMD.jl b/src/PreprocessMD.jl
@@ -35,7 +35,10 @@ const OPTIONAL_INT_TYPES = Union{Int,Nothing}
 """
 	function add_label_column!(feature_df, source_df, new_column[, id])
 
-Add column to a DataFrame based on symbol presence in the target DataFrame
+Add a label column to a DataFrame based on symbol presence in the target DataFrame
+
+A column from the target is not copied.
+Instead, the new column is a `CategoricalArray` containing `true` for any ID that is present in the target and `false` otherwise.
 
 # Arguments
 - `feature_df::AbstractDataFrame`: feature DataFrame to which label column is added