From 0eaf67db561ce5541231bbb87bbb16bef084d6e5 Mon Sep 17 00:00:00 2001 From: Cameron Mattson Date: Thu, 21 Nov 2024 13:25:50 -0700 Subject: [PATCH] Added docs link in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d28f757..500246b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Pairwise Compare This tool allows the user to compare groups of data specified in a tidy-wide pandas dataframe with ease. In this repo the capabilities of the PairwiseCompareManger are shown through examples using a dataset from the [nf1_schwann_cell_painting_data](https://github.com/WayScience/nf1_schwann_cell_painting_data). -These examples can be found in the docs. +These examples can be found in the [docs](https://github.com/WayScience/pairwise_compare/tree/main/docs). Although, most of the development efforts can be found in the `src` folder. Users should almost exclusively interact with the [PairwiseCompareManager](https://github.com/WayScience/pairwise_compare/blob/main/src/comparison_tools/PairwiseCompareManager.py), however, there may be rare exceptions. If you choose to interact with another component of the tool, then there will be less input validation safeguards available.