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.

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

Expand documentation on how to set distances in the tbl configuration file #20

Merged
Merged
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions docs/src/configuration_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ A minimal configuration file would look like this:
- `surface_as_passive`: if true, the passive residues are defined based on the surface accessibility of the residues (_requires structure_)
- `filter_buried`: if true, the buried residues are filtered out (_requires structure_)
- `filter_buried_cutoff`: the cutoff to consider a residue as buried, default = 0.7 (_requires structure_)
- `target_distance`: the distance to consider two residues as interacting, default = 2.0 (_see Note_)
- `lower_margin`: the lower bound correction subtracted from the `target_distance` to define the lower distance boundary.
- `upper_margin`: the upper bound correction added to the target_distance to define the upper distance boundary.

> **Note**: Check [this paper](https://doi.org/10.1038/s41596-018-0018-5) for a deeper explanation about the target distance and the margins. The default value of 2.0Å (which might seem short) is used because of the way the effective distance is calculated from all pairwise combinations of atom it will always be shorter than the shortest distance measured.
A configuration file with optional fields would look like this:

Expand Down Expand Up @@ -140,3 +145,15 @@ Optional fields are:
- type: float
- description: the cutoff to consider a residue as buried, default = 0.7
- requires: `structure`

- `target_distance`
- type: float
- description: the distance to consider two residues as interacting, default = 2.0

- `lower_margin`
- type: float
- description: the lower bound correction subtracted from the `target_distance` to define the lower distance boundary

- `upper_margin`
- type: float
- description: the upper bound correction added to the target_distance to define the upper distance boundary