Skip to content

Commit 8e8153b

Browse files
committed
Prepare for new README
1 parent 1045f8a commit 8e8153b

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ Overview of the current workflow:
1616

1717
### A Brief Step-by-Step Tutorial
1818

19-
1. Clone the 'Workflow' and 'Data' folder to a local drive.
19+
Work In Progress
20+
<!-- 1. Clone the 'Workflow' and 'Data' folder to a local drive.
2021
2122
*Optional (if exporting data from Cytobank):* Go to the working illustration page (Illustrations - My working illustration), highlight the population(s) of interest, and export events as untransformed text files (Actions - Export - Export events, with *'Include header with FCS filename'* unchecked).
2223
@@ -36,10 +37,12 @@ Overview of the current workflow:
3637
3738
6. **Heatmap:** To visualise EMD/DREMI scores in heatmaps, copy the EMD/DREMI calculation outputs to the 'Workflow/input/5v1-emd_dremi_htmp' folder. Run 5v1-emd_dremi_htmp.py and follow the instructions in the GUI. The current version of the script accepts one EMD data file and one DREMI data file (with 'EMD' and 'DREMI' in their file names respectively) to be visualised in the heatmaps generated.
3839
39-
7. **Principal component analysis (PCA):** To perform PCA and visualise the results, copy the EMD/DREMI calculation outputs to the 'Workflow/input/5v2-pca' folder. Run 5v2-pca.py and follow the instructions in the GUI.
40+
7. **Principal component analysis (PCA):** To perform PCA and visualise the results, copy the EMD/DREMI calculation outputs to the 'Workflow/input/5v2-pca' folder. Run 5v2-pca.py and follow the instructions in the GUI. -->
4041

4142
## Dependencies
4243

44+
We strongly encourage using [conda](https://docs.conda.io/en/latest/miniconda.html) to setup an environment from 'conda_env.yml'.
45+
4346
* Python: Tested with Python v3.6 and v3.7. Used in the backbone of the workflow and most computational steps.
4447
* `numpy`
4548
* `pandas`
@@ -67,4 +70,5 @@ Overview of the current workflow:
6770

6871
## Authors
6972

70-
The work here is actively being developed by Ferran Cardoso ([@FerranC96](https://github.com/FerranC96)) and Dr. Xiao Qin ([@qinxiao1990](https://github.com/qinxiao1990)). Based on the original work of Pelagia Kyriakidou.
73+
The work here is actively being developed by Ferran Cardoso ([@FerranC96](https://github.com/FerranC96)) and Dr. Xiao Qin ([@qinxiao1990](https://github.com/qinxiao1990)).
74+
Based also on original work by Pelagia Kyriakidou.

0 commit comments

Comments
 (0)