Skip to content

Commit e03bb26

Browse files
committed
stringdocs updated
1 parent f2e291d commit e03bb26

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

src/load_vpop.jl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ A struct representing a Virtual Population.
66
77
### Fields
88
- `df::D`: A DataFrame containing the virtual population data.
9+
- `endpoints::E`: A collection of clinical endpoints associated with the virtual population.
910
- `scenarios::SC`: A collection of scenarios associated with the virtual population.
1011
- `npop::Int64`: The number of individuals in the virtual population.
1112
- `preselected::S`: Pre-selected individuals in the virtual population.
13+
- `objective_value::Union{Nothing,Float64}`: The objective value of the optimization problem for the selected cohort, if available.
1214
1315
Use `load_vpop(pop::DataFrame)` to create an instance of `VirtualPopulation` from DataFrame.
1416
"""

src/select_cohort.jl

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11

2+
"""
3+
select_cohort(pop::VirtualPopulation, data::Vector{M}, vpnum::Int; kwargs...) where {M<:DigiPopData.MetricBinding}
4+
5+
Select a cohort of virtual patients from a `VirtualPopulation` that best matches the provided data. The selection is performed by solving a Mixed-Integer Programming (MIP) optimization problem.
6+
# Arguments
7+
- `pop::VirtualPopulation`: The DataFrame with plausiblel population from which to select the cohort.
8+
- `data::Vector{M}`: A vector of metric bindings that define the data to match. See DigiPopData.jl for details on how to create metric bindings.
9+
- `vpnum::Int`: The desired size of the virtual population cohort to be selected.
10+
- `kwargs...`: Additional keyword arguments for the optimization solver (e.g., optimizer choice, time limits, etc.).
11+
"""
212
function select_cohort(pop::VirtualPopulation, data::Vector{M}, vpnum::Int; kwargs...) where {M<:DigiPopData.MetricBinding}
313

414
@assert (0 < vpnum <= length(pop)) "Virtual Population size `vpnum` should be in the interval vpnum ∈ (0, $(length(pop))]."

0 commit comments

Comments
 (0)