Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix format documentation regarding parameter scale #289

Merged
merged 2 commits into from
Feb 14, 2020
Merged

Fix format documentation regarding parameter scale #289

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2da1c4
Fix format documentation regarding parameter scale
dweindl Feb 13, 2020
41cce5b
Merge branch 'develop' into fix_parameter_doc
dweindl Feb 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions doc/documentation_data_format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,25 +340,20 @@ Additional columns may be added.

- `parameterId` [STRING, NOT NULL]

The `parameterId` of the parameter described in this row. This has be
identical to the parameter IDs specified in the SBML model or in the
The `parameterId` of the parameter described in this row. This has to match
the ID of a parameter specified in the SBML model, a parameter introduced
as override in the condition table, or a parameter occurring in the
`observableParameters` or `noiseParameters` column of the measurement table
(see above).

There must exist one line for each parameterId specified in the SBML model
(except for placeholder parameter, see above) or the `observableParameters` or
`noiseParameters` column of the measurement table.

- `parameterName` [STRING, OPTIONAL]

Parameter name to be used e.g. for plotting etc. Can be chosen freely. May
or may not coincide with the SBML parameter name.

- `parameterScale` [lin|log|log10]

Scale of the parameter. The parameters and boundaries and the nominal
parameter value in the following fields are expected to be given in this
scale.
Scale of the parameter to be used during parameter estimation.

- `lowerBound` [NUMERIC]

Expand Down