Skip to content

Commit 62aa84c

Browse files
authored
Merge pull request #33 from TASBE/coverney.updateREADME
Updated README
2 parents 3c9908a + 58a3f89 commit 62aa84c

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
This is a tutorial for how to use the TASBE Flow Analytics package.
2-
(https://github.com/TASBE/TASBEFlowAnalytics)
1+
# TASBE Flow Analytics Tutorial
2+
This is a tutorial for how to use the [TASBE Flow Analytics package](https://github.com/TASBE/TASBEFlowAnalytics).
33

44
Example code in this tutorial is distributed, insofar as possible, in
55
the public domain.
@@ -16,19 +16,19 @@ the following two publications:**
1616
Biology Devices," MIT CSAIL Tech Report 2012-008, April 2012.
1717
http://hdl.handle.net/1721.1/69973
1818

19-
# Organization
19+
## Organization
2020

2121
The material in this tutorial is organized into three collections:
2222

23-
## Quick Start Templates
23+
### Quick Start Templates
2424

2525
These are prototypical templates for using the TASBE Flow Analytics package.
2626
Most common uses can be executed simply by copying these files, changing configuration commands to match your machine, and replacing the example FCS files it references with your own.
2727

28-
* template_colormodel: Use a set of controls to build a "color model", which TASBE Flow Analytics uses to gate and compensate data and to translate it into calibrated units.
28+
* template_colormodel: Use a set of controls to build a "color model", which TASBE Flow Analytics uses to gate and compensate data and to translate it into calibrated units. (This folder also contains a template that allows for beadfile comparisons.)
2929
* template_analysis: Use a color model to analyze experimental data, for any experiment organized in one of several standard designs.
3030

31-
## Prototypical Example Data
31+
### Prototypical Example Data
3232

3333
The quick-start templates can be applied to prototypical example data to see how they work and get a feel for what good results look like:
3434

@@ -37,7 +37,7 @@ The quick-start templates can be applied to prototypical example data to see how
3737

3838
Example flow cytometry files are provided courtesy of Prof. Ron Weiss (MIT).
3939

40-
## Educational Material on Flow Cytometry
40+
### Educational Material on Flow Cytometry
4141

4242
This material is optional, and is intended to help the user understand better how calibrated flow cytometry works and why controls are organized the way they are in order to build color models.
4343

0 commit comments

Comments
 (0)