Files and folders¶
PlatAnJr keeps two kinds of state in two different places: application settings in your
user profile, and everything about a dataset in an INFO folder next to the data.
Your data folder¶
D:\Experiments\Plate 17\
A01.fcs
A02.fcs
...
INFO\
PlateMap.csv
selectedpars.ini
...
screen.ppj
The FCS files are never modified. Everything PlatAnJr writes goes in INFO.
What lives in INFO¶
| File | Holds |
|---|---|
PlateMap.csv |
Which file is in which well. Written when you approve the Plate dialog, and reused on every later open |
selectedpars.ini |
The parameters you chose to load |
DisabledWells.csv |
Wells excluded from the analysis |
Defaults.par, DefaultsV2.par |
Default scale settings per parameter |
Spillover.dat |
The compensation matrix, when saved to the folder |
Layout.pap |
The plate layout written by Save Layout on the Heat Map tab |
UnmixingPanel.csv |
The unmixing panel definition |
Unmixer_Pars.ini |
Which channels take part in unmixing |
PlateEditor.ini |
The Plate Editor's entries - each file's well type, analyte, dye and comments - filed by file name |
models\ |
Saved embedding models and maps - see Where models are kept |
Ribbon_Pars.ini, Well_Ribbon_Pars.ini, SSM_Pars.ini, Pahsor_Pars.ini, Embed_Pars.ini, FlowSOM_Pars.ini, Pheno_Pars.ini |
Remembered parameter selections per node type |
*.ppj |
Your saved projects - this is the default location the save dialog offers |
Because all of this is inside the data folder, copying the folder copies the analysis. Hand someone the folder and they get your plate layout, your panel, your scales and your projects along with the data.
Conversely, deleting INFO resets everything about that dataset except the FCS files
themselves - which is the clean way to start a plate over.
Your user profile¶
%APPDATA%\PlatAnJr\
PlatAnJr.ini
ProjectBackup.pap
log\
StackTrace.log
| File | Holds |
|---|---|
PlatAnJr.ini |
All application options, window state, recent folders, recent projects |
ProjectBackup.pap |
The automatic backup restored by Load last saved protocol |
log\ |
The log, one file a day |
StackTrace.log |
A record of unexpected errors - attach it to a bug report |
Nothing here is needed to read data. Deleting the folder resets PlatAnJr to defaults.
Shared data¶
Data that belongs to no one dataset is installed in the public Documents folder,
C:\Users\Public\Documents:
| Folder | Holds |
|---|---|
PlatAnJr\Manual |
This manual; beside it, the sensor calibration data and scripts |
CDDB |
The CD database, CDDB.dat |
BFSpectra |
The spectra database, the spectrum collection SpectrumDB.DB and the device functions - shared with BFSpectra - and the BFSpectra manual |
See Installing for what an update does to them.
File types¶
| Extension | What it is |
|---|---|
.fcs |
Flow-cytometry data, the input |
.ppj |
A PlatAnJr project - nodes, gates, links, scales |
.pap |
A legacy PlatAn project, read-only; also the format of the automatic backup |
.gat |
Gates saved from a single node |
.csv |
Every table export, plate map, spillover and unmixing matrix |
.ini |
Settings, at both the application and the dataset level |
What to back up, what to archive¶
For an analysis you may need to reproduce: the data folder including INFO. That is
self-contained.
For a result you are reporting: the CSV exports, plus the .ppj that produced them.
The project records exactly which gates gave which numbers.
Not worth keeping: %APPDATA%\PlatAnJr\ - it is preferences and caches, and PlatAnJr
recreates it.
Sharing an analysis¶
To send a colleague a complete, reproducible analysis:
- Make sure the
.ppjis saved into the data folder'sINFOfolder. - Zip the whole data folder.
They open the folder as a plate - the plate map, the parameter selection and the panel are
all read from INFO - then load the project, and see exactly what you saw.
To send only the gating strategy for use on their data, send the .ppj on its own. It
refers to parameters by name, so it applies to any dataset with matching channel names -
see Projects across datasets.