.TH density-fitness 1 "2020-11-23" "version 1.0.0" "User Commands"
.if n .ad l
.nh
.SH NAME
density\-fitness \- Calculates per-residue electron density scores real-space R, real-space correlation coefficient, EDIAm, and OPIA
.SH SYNOPSIS
density\-fitness [OPTION] <mtz-file> <coordinates-file> [output]
.sp
density\-fitness [OPTION] --hklin=<mtz-file> --xyzin=<coordinates-file> [--output=<output>]
.sp
density\-fitness [OPTION] --fomap=<fo-map-file> --dfmap=<df-map-file> --reslo=<low-resolution> --reshi=<high-resolution> --xyzin=<input [--output=<output>]
.SH DESCRIPTION
The program density-fitness calculates electron density metrics,
for main- (includes Cβ atom) and side-chain atoms of individual residues.
.sp
For this calculation, the program uses the structure model in either PDB 
or mmCIF format and the electron density from the 2mFo-DFc and mFo-DFc maps. 
If these maps are not readily available, the MTZ file and model can be used 
to calculate maps clipper. Density-fitness support both X-ray and electron 
diffraction data. 
.sp
This program is essentially a reimplementation of \fIedstats\fR, a program
available from the CCP4 suite. However, the output now contains only the
RSR, SRSR and RSCC fields as in \fIedstats\fR with the addition of EDIAm
and OPIA and no longer requires pre-calculated map coefficients.
.TP
The real-space R factor (RSR) is defined (Brändén & Jones, 1990; Jones et al., 1991) as:
.sp
RSR = Σ |ρobs - ρcalc| / Σ |ρobs + ρcalc|
.P
The SRSR is the estimated sigma for RSR.
.TP
The real-space correlation coefficient (RSCC) is defined as:
.sp
RSCC = cov(ρobs,ρcalc) / sqrt(var(ρobs) var(ρcalc))
.sp
where cov(.,.) and var(.) are the sample covariance and variance (i.e. calculated 
with respect to the sample means of ρobs and ρcalc).
.P
The EDIAm score is a per-residue score based on the atomic EDIA value and the OPIA
score gives the percentage of atoms in the residue with EDIA score is above 0.8.
.SH OPTIONS
When using MTZ files, the input and output files do not need the option flag.
If no output file is given, the result is printed to \fIstdout\fR.
.sp
When using map files, the resolution \fBmust\fR be specified using the
\fIreshi\fR and \fIreslo\fR options.
.TP
\fB--xyzin\fR
The coordinates file in either PDB or mmCIF format. This file may be compressed
with gzip or bzip2.
\fB--fomap\fR and \fB--dfmap\fR
The \fI2mFo-DFc\fR and \fImFo-DFc\fR map files respectively. Both are required
and if these are specified, the resolution \fBmust\fR also be specified.
.TP
\fB--reslo\fR and \fB--reshi\fR
The low and high resolution for the specified map files.
.TP
\fB--hklin\fR
The MTZ file. If this option is specified, the maps will be calculated using
the information in this file.
.TP
\fB--sampling-rate\fR
The sampling rate to use when creating maps. Default is 0.75.
.TP
\fB--recalc\fR
By default the maps are read from the MTZ file, but you can also opt to
recalculate the maps, e.g. when the structure no longer corresponds to
the structure used to calculate the maps in the MTZ file.
.TP
\fB--aniso-scaling\fR
Accepted values for this option are \fIobserved\fR and \fIcalculated\fR or \fInone\fR.
Used when recalculating maps.
.TP
\fB--no-bulk\fR
When specified, a bulk solvent mask is not used in recalculating the maps.
.TP
\fB--dict\fR=<file>
Dictionary file containing restraints for residues in this specific target.
.TP
\fB--no-validate\fR
Omit the validation of the input mmCIF file. This will force output even in
case the input file contains errors.
.TP
\fB--electron-scattering\fR
Use electron scattering factors instead of X-ray scattering factors.
.TP
\fB--use-auth-ids\fR
By default, when reading mmCIF files, the label_xxx_id is used in the
edstats output. Use this flag to force output with the auth_xxx_ids.
.TP
\fB--output-format\fR
By default a JSON file is written, unless the filename ends with .eds.
Use this option to force output in \fIedstats\fR or \fIjson\fR format.
.TP
\fB--verbose\fR,\fB-V\fR
Be more verbose, useful to diagnose validation errors.
.SH REFERENCES
References:
.TP
Statistical quality indicators for electron-density maps
Tickle, I. J. (2012). Acta Cryst. D68, 454-467.
DOI: 10.1107/S0907444911035918
.TP
Estimating Electron Density Support for Individual Atoms and Molecular Fragments in X-ray Structures
Agnes Meyder, Eva Nittinger, Gudrun Lange, Robert Klein, and Matthias Rarey
Journal of Chemical Information and Modeling 2017 57 (10), 2437-2447
DOI: 10.1021/acs.jcim.7b00391
.SH AUTHOR
Written by Maarten L. Hekkelman <maarten@hekkelman.com>
.SH "REPORTING BUGS"
Report bugs at https://github.com/PDB-REDO/density-fitness/issues