Skip to content

Commit 441ae98

Browse files
authored
Merge pull request #107 from drbergman/development
doc fix
2 parents 5564740 + 5dfa3d0 commit 441ae98

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/src/man/analyzing_output.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
## Loading output
44

55
### `PhysiCellSnapshot`
6-
The base unit of PhysiCell output is the [`PhysiCellSnapshot`](@ref).
6+
The base unit of PhysiCell output is the `PhysiCellSnapshot`.
77
These are currently considered pcvct internals and so the API may change.
88
Each snapshot records the path to the PhysiCell output folder, its index in the sequence of outputs, the time of the snapshot in the simulation, and optionally the cell, substrate, and mesh data at that snapshot.
99

1010
### `PhysiCellSequence`
11-
A [`PhysiCellSequence`](@ref) is the full sequence of snapshots corresponding to a single PhysiCell simulation.
11+
A `PhysiCellSequence` is the full sequence of snapshots corresponding to a single PhysiCell simulation.
1212
As with `PhysiCellSnapshot`'s, these are currently considered internals and their API may change.
1313
In addition to the path to the PhysiCell output folder and the vector of `PhysiCellSnapshot`'s, it holds metadata for the simulation.
1414

1515
### `getCellDataSequence`
16-
The main function to get sequences of cell data is [`getCellDataSequence`](@ref).
16+
The main function to get sequences of cell data is `getCellDataSequence`.
1717
It accepts any of a simulation ID (`<:Integer`), a simulation (`::Simulation`), or a sequence (`::PhysiCellSequence`) and either a single label (`::String`) or a vector of labels (`::Vector{String}`).
1818
For each cell in the simulation (as determined by the cell ID), the output creates a dictionary entry (the key is the integer cell ID) whose value is a named tuple with the input labels as keys as well as `:time`.
1919
This means that if one sets
@@ -77,8 +77,8 @@ plotbycelltype(Sampling(1); include_cell_types=["epi", "mes", ["epi", "mes"]], c
7777
## Substrate analysis
7878
pcvct supports two ways to summarize substrate information over time.
7979

80-
### AverageSubstrateTimeSeries
81-
An [`AverageSubstrateTimeSeries`](@ref) gives the time series for the average substrate across the entire domain.
80+
### `AverageSubstrateTimeSeries`
81+
An `AverageSubstrateTimeSeries` gives the time series for the average substrate across the entire domain.
8282

8383
```julia
8484
simulation_id = 1
@@ -88,7 +88,7 @@ plot(asts.time, asts["oxygen"])
8888
```
8989

9090
### `ExtracellularSubstrateTimeSeries`
91-
An [`ExtracellularSubstrateTimeSeries`](@ref) gives the time series for the average substrate concentration in the extracellular space neighboring all cells of a given cell type.
91+
An `ExtracellularSubstrateTimeSeries` gives the time series for the average substrate concentration in the extracellular space neighboring all cells of a given cell type.
9292
In a simulation with `cd8` cells and `IFNg` diffusible substrate, plot the average concentration of IFNg experienced by CD8+ T cells using the following:
9393

9494
```julia

0 commit comments

Comments
 (0)