Skip to content

Commit 4d016cf

Browse files
committed
docu update and new logo image
1 parent 52adc7f commit 4d016cf

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ mex -O CCGHeart.c
4444
5. That's it! Now you can explore the software with below example data or try one of the tutorials.
4545

4646
### Try the Cell Explorer with example data
47-
There is an example dataset included in the repository for trying the Cell Explorer. Load the mat-file [`cell_metrics_batch.mat`](https://github.com/petersenpeter/Cell-Explorer/blob/master/LoadCellMetricBatch.m) into Matlab and type:
47+
There is an example dataset included in the repository for trying the Cell Explorer. Load the mat-file [`cell_metrics_batch.mat`](https://github.com/petersenpeter/Cell-Explorer/blob/master/LoadCellMetricsBatch.m) into Matlab and type:
4848
```m
4949
CellExplorer('metrics',cell_metrics)
5050
```

docs/pipeline/running-pipeline.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Following the definition of metadata, the cell metrics calculation process can b
2828
![](https://buzsakilab.com/wp/wp-content/uploads/2020/03/FlowChart_pipeline.png)
2929

3030
### Running Cell Explorer
31-
The Cell Explorer can be used to display single cell_metrics files as well as batches. Batch loading is performed with the script LoadCellMetricBatch. The advanced flowchart below further details the capabilities of loading various GUIs from the Cell Explorer (gui_session, gui_MonoSyn and gui_DeelSuperficial) as well as do spike raster plots, that requires access to the local spikes struct and potentially also manipulation and events files if plotting PSTHs.
31+
The Cell Explorer can be used to display single cell_metrics files as well as batches. Batch loading is performed with the script LoadCellMetricsBatch. The advanced flowchart below further details the capabilities of loading various GUIs from the Cell Explorer (gui_session, gui_MonoSyn and gui_DeelSuperficial) as well as do spike raster plots, that requires access to the local spikes struct and potentially also manipulation and events files if plotting PSTHs.
3232
![](https://buzsakilab.com/wp/wp-content/uploads/2020/03/FlowChart_CellExplorer.png)
3333

3434
## Running pipeline from a data path
@@ -46,11 +46,11 @@ session = gui_session(session);
4646

4747
To run the pipeline from the Matlab Command Window from the session struct type:
4848
```m
49-
cell_metrics = calc_CellMetrics('session', session);
49+
cell_metrics = ProcessCellMetrics('session', session);
5050
```
5151
You can also run it directly from a basepath and generate the session struct directly:
5252
```m
53-
cell_metrics = calc_CellMetrics;
53+
cell_metrics = ProcessCellMetrics;
5454
```
5555
When calling the pipeline with the sessionTemplate, a GUI will be shown allowing you to edit the metadata both for the input parameters and the session struct.
5656

@@ -63,15 +63,15 @@ To open multiple sessions together you can run the Cell Explorer in batch mode.
6363

6464
```m
6565
bsasepaths = {'sessionName1','sessionName2','sessionName3'};
66-
cell_metrics = LoadCellMetricBatch('basepaths',bsasepaths);
66+
cell_metrics = LoadCellMetricsBatch('basepaths',bsasepaths);
6767
cell_metrics = CellExplorer('metrics',cell_metrics);
6868
```
6969
As you perform classifications in the Cell Explorer, you may save back to the original cell metrics stored with the sessions defined above. You can perform the batch mode from a list of paths as well.
7070

7171
## Running pipeline using the Buzsaki lab database
7272
The Cell Explorer pipeline uses a single Matlab struct for handling metadata. The struct is automatically loaded from the buzsaki lab database if you are running the pipeline with the database, and is located in the base path once a session has been processed. To run the pipeline on a session named 'PetersSession' using the database type:
7373
```m
74-
cell_metrics = calc_CellMetrics('sessionName','PetersSession');
74+
cell_metrics = ProcessCellMetrics('sessionName','PetersSession');
7575
```
7676
To view the result in the Cell Explorer type:
7777
```m
@@ -82,7 +82,7 @@ To open multiple sessions together you can run the Cell Explorer in batch mode.
8282

8383
```m
8484
sessionNames = {'sessionName1','sessionName2','sessionName3'};
85-
cell_metrics = LoadCellMetricBatch('sessions',sessionNames);
85+
cell_metrics = LoadCellMetricsBatch('sessions',sessionNames);
8686
cell_metrics = CellExplorer('metrics',cell_metrics);
8787
```
8888
As you perform classifications in the Cell Explorer, you may save back to the original cell metrics stored with the sessions defined above. You can perform the batch mode from a list of paths as well.

docs/tutorials/database-tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ spikes = loadSpikes('session',session);
4545
7. Loading via database/metadata
4646
1. Run the processing pipeline and CellExplorer from `sessionName`
4747
```m
48-
cell_metrics = calc_CellMetrics('sessionName',sessionName);
48+
cell_metrics = ProcessCellMetrics('sessionName',sessionName);
4949
cell_metrics = CellExplorer('metrics',cell_metrics);
5050
```
5151
1. Run Cell Explorer directly from `sessionName`
@@ -55,7 +55,7 @@ cell_metrics = CellExplorer('sessionName',sessionName);
5555
1. Run Cell Explorer from list of `sessionNames`
5656
```m
5757
sessionNames = {'ham11_27-29_amp','ham11_34-36_amp'};
58-
cell_metrics = LoadCellMetricBatch('sessions',sessionNames);
58+
cell_metrics = LoadCellMetricsBatch('sessions',sessionNames);
5959
cell_metrics = CellExplorer('metrics',cell_metrics);
6060
```
6161

docs/tutorials/general-tutorial.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ cd(basepath)
1717
```m
1818
session = sessionTemplate(basepath,'showGUI',true);
1919
```
20-
3. Run the cell metrics pipeline `calc_CellMetrics` using the session struct as input
20+
3. Run the cell metrics pipeline `ProcessCellMetrics` using the session struct as input
2121
```m
22-
cell_metrics = calc_CellMetrics('session', session);
22+
cell_metrics = ProcessCellMetrics('session', session);
2323
```
2424
4. Visualize the cell metrics in the Cell Explorer
2525
```m
@@ -29,7 +29,7 @@ cell_metrics = CellExplorer('metrics',cell_metrics);
2929
```m
3030
basenames = {'Rat08-20130708','Rat08-20130709'};
3131
clusteringpaths = {'/Volumes/buzsakilab/Buzsakilabspace/Datasets/GirardeauG/Rat08/Rat08-20130708','/Volumes/buzsakilab/Buzsakilabspace/Datasets/GirardeauG/Rat08/Rat08-20130709'};
32-
cell_metrics = LoadCellMetricBatch('clusteringpaths',clusteringpaths,'basenames',basenames);
32+
cell_metrics = LoadCellMetricsBatch('clusteringpaths',clusteringpaths,'basenames',basenames);
3333
cell_metrics = CellExplorer('metrics',cell_metrics);
3434
```
3535

logoCellExplorer.png

6.9 KB
Loading

0 commit comments

Comments
 (0)