Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
DOC: Add make help usage and simplify GitHub repository name
  • Loading branch information
pan14001 committed Mar 23, 2017
1 parent e8c82ff commit 62415b2
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Expand Up @@ -51,20 +51,38 @@ where each well corresponds to a protein being knocked down.
Usage
-----

All programs are run using a single `Makefile`.
Type the `make help` to see a list of options:

``` sh
Usage: make [TARGET] ...

Targets:
all (Default) Run full pipeline from image processing to plots.
help Show this help.
z-projection Generate maximum intensity projection images.
cellprofiler Collect statistics about all images.
gui-cellprofiler Interactively run CellProfiler.
stats Find significant wells from cellprofiler measurements.
clean-all Delete all output.
```

Run the `Makefile` in this directory to generate all results.

``` sh
make
make all
```

Depending

To tune CellProfiler's image processing,
it is helpful to save results in a separate directory.
One can clone this repository using a different directory name,
and link to the processed image set of the original:

``` sh
cd ..
git clone git@github.uconn.edu:MelloneLab/RNAi_plate_analysis_all.git rnai-screen-tf_20170314
git clone git@github.uconn.edu:MelloneLab/rnai-screen-tf.git rnai-screen-tf_20170314
cd rnai-screen-tf_20170314
rm -rf z_projection
ln -s ../../rnai-screen-tf/results/z_projection z_projection
Expand Down

0 comments on commit 62415b2

Please sign in to comment.