Scaled unmerged data files: Difference between revisions

From CCP4 wiki
Jump to navigation Jump to search
(→‎Where to find scaled unmerged data?: add autoPROC and put autoBUSTER in brackets because I don't think it applies)
m (correct filename from xdsme)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Depositing ==
== Depositing ==
A deposition to the wwPDB may include scaled unmerged data (as part of the
A deposition to the wwPDB may not only include merged reflection data (i.e. the typical input to the refinement program), but also scaled unmerged data (as part of the
[https://www.wwpdb.org/news/news?year=2021#60638da1931d5660393084c3 Improved support for extended PDBx/mmCIF structure factor files]
[https://www.wwpdb.org/news/news?year=2021#60638da1931d5660393084c3 Improved support for extended PDBx/mmCIF structure factor files]
announced in 2021).
announced in 2021).
An mmCIF with such data can be
A PDBx/mmCIF reflection data file with such data can be


*generated by MX software suite (preferred way, currently supported only by GPhL),
*generated by a MX software suite directly (which is often the preferred way, since it will typically also contain the data quality metrics describing the data) - see e.g. [https://www.globalphasing.com/autoproc/ autoPROC] from [https://www.globalphasnig.com/ Global Phasing],
*generated by [https://project-gemmi.github.io/wasm/mxdepo.html this web app] or the equivalent command-line program, both developed as part of project GEMMI.
*generated by [https://project-gemmi.github.io/wasm/mxdepo.html this web app] or the equivalent command-line program, both developed as part of project [https://github.com/project-gemmi/gemmi GEMMI].


The prerequisite for the latter is having around a file with scaled unmerged data.
The prerequisite for the latter is a file with scaled unmerged data.
 
 
Please note that autoPROC+BUSTER outputs reflection data mmCIF that contains
* The data that went into the final refinement step (to provide the possibility for validation and re-refinement)
* The output of the refinement program - including map coefficients for the 2mFo-DFc (electron) density map and the mFo-DFc difference density map. This will allow a user to compute the maps exactly as seen by the depositor, i.e. those maps any original model interpretation were based upon.
* (optionally) the scaled and merged data before a final step of data selection, application of a cut-off or re-scaling.
* The scaled and unmerged data discussed on this page.
* (optionally) Additional reflection data that describe for example subsets of the data, different wavelengths or such.
* A set of data quality metrics for each of those separate reflection datablocks (R-values, completeness, redundancy, CC1/2, mean I/sig(I) etc).


== Where to find scaled unmerged data? ==
== Where to find scaled unmerged data? ==


===Aimless===
===[http://legacy.ccp4.ac.uk/html/aimless.html Aimless]===
If you run Aimless from the command-line add option <code>OUTPUT MTZ UNMERGED</code>.
If you run Aimless from the command-line add option <code>OUTPUT MTZ UNMERGED</code>.


=== autoPROC (autoBUSTER?) ===
=== [https://www.globalphasing.com/autoproc/ autoPROC] ===
Scaled unmerged data is stored in <code>scaled.mtz</code> as well as in mmCIF file (GPhL developers recommend to use the mmCIF file and <code>aB_deposition_combine</code> to prepare files for deposition).
Individual scaled unmerged data is stored in <code>*unmerged.mtz</code>. However, full deposition-ready PDBx/mmCIF files are already generated (including multiple datablocks with merged and unmerged data) - including the full set of data quality metrics: <code>Data_1_autoPROC_STARANISO_all.cif</code> (for the anisotropic/STARANISO analysed data) and <code>Data_2_autoPROC_TRUNCATE_all.cif</code> (for the traditional/isotropic data). These can be used as-is for deposition and no subsequent format conversion from MTZ is required. Furthermore, no additional extraction of data quality metrics should be necessary. If [https://www.globalphasing.com/buster/ BUSTER] was used for structure refinement, the <code>aB_deposition_combine</code> tool can be used to combine the reflection mmCIF file from refinement with this one from data processing - and transfer the correct set of data quality metrics into the model mmCIF file.
 
See also [https://www.globalphasing.com/buster/wiki/index.cgi?DepositionMmCif here] for more details.


===CCP4i===
===CCP4i===
Line 56: Line 67:
CCP4 SCALA program got obsoleted in favor of Aimless. It has option <code>OUTPUT UNMERGED</code>.
CCP4 SCALA program got obsoleted in favor of Aimless. It has option <code>OUTPUT UNMERGED</code>.


=== StarANISO ===
=== [https://staraniso.globalphasing.org STARANISO] ===
?
See [https://staraniso.globalphasing.org/deposition_about.html here] for up-to-date details regarding deposition and mmCIF files generated already on the [https://staraniso.globalphasing.org STARANISO server].


===XDS / XSCALE===
===[http://xds.mpimf-heidelberg.mpg.de XDS / XSCALE]===
Scaled unmerged data from XDS CORRECT and XSCALE is written in the XDS_ASCII.HKL format. The GEMMI converter can use these files directly.
Scaled unmerged data from XDS CORRECT and XSCALE is written in the XDS_ASCII.HKL format. The GEMMI converter can use these files directly.


===xdsme===
===xdsme===


Since xdsme uses XDS/XSCALE, see above.
Uses XDS and outputs scaled unmerged <code>XDS_ASCII.HKL</code> and <code>{image-glob}_pointless.mtz</code>. The latter is converted from the former using Pointless.


===xia2===
===xia2===
Scaled unmerged MTZ file is stored as <code>DataFiles/*_scaled_unmerged.mtz</code>.
Scaled unmerged MTZ file is stored as <code>DataFiles/*_scaled_unmerged.mtz</code>.

Latest revision as of 13:33, 11 May 2021

Depositing[edit | edit source]

A deposition to the wwPDB may not only include merged reflection data (i.e. the typical input to the refinement program), but also scaled unmerged data (as part of the Improved support for extended PDBx/mmCIF structure factor files announced in 2021). A PDBx/mmCIF reflection data file with such data can be

  • generated by a MX software suite directly (which is often the preferred way, since it will typically also contain the data quality metrics describing the data) - see e.g. autoPROC from Global Phasing,
  • generated by this web app or the equivalent command-line program, both developed as part of project GEMMI.

The prerequisite for the latter is a file with scaled unmerged data.


Please note that autoPROC+BUSTER outputs reflection data mmCIF that contains

  • The data that went into the final refinement step (to provide the possibility for validation and re-refinement)
  • The output of the refinement program - including map coefficients for the 2mFo-DFc (electron) density map and the mFo-DFc difference density map. This will allow a user to compute the maps exactly as seen by the depositor, i.e. those maps any original model interpretation were based upon.
  • (optionally) the scaled and merged data before a final step of data selection, application of a cut-off or re-scaling.
  • The scaled and unmerged data discussed on this page.
  • (optionally) Additional reflection data that describe for example subsets of the data, different wavelengths or such.
  • A set of data quality metrics for each of those separate reflection datablocks (R-values, completeness, redundancy, CC1/2, mean I/sig(I) etc).

Where to find scaled unmerged data?[edit | edit source]

Aimless[edit | edit source]

If you run Aimless from the command-line add option OUTPUT MTZ UNMERGED.

autoPROC[edit | edit source]

Individual scaled unmerged data is stored in *unmerged.mtz. However, full deposition-ready PDBx/mmCIF files are already generated (including multiple datablocks with merged and unmerged data) - including the full set of data quality metrics: Data_1_autoPROC_STARANISO_all.cif (for the anisotropic/STARANISO analysed data) and Data_2_autoPROC_TRUNCATE_all.cif (for the traditional/isotropic data). These can be used as-is for deposition and no subsequent format conversion from MTZ is required. Furthermore, no additional extraction of data quality metrics should be necessary. If BUSTER was used for structure refinement, the aB_deposition_combine tool can be used to combine the reflection mmCIF file from refinement with this one from data processing - and transfer the correct set of data quality metrics into the model mmCIF file.

See also here for more details.

CCP4i[edit | edit source]

i1 has a few tasks that scale data:

  • Scale and Merge Intensities – it uses obsolete SCALA program. To write scaled unmerged data check ☑ Customize Scala process and select Output scaled unmerged & no outliers (?).
  • Symmetry, Scale, Merge (Aimless) – check ☑ Customize output options and select MTZ Output both merged and unmerged.
  • Find Symmetry, Scale & Merge (Scala) – obsolete, use Aimless instead.

CCP4i2[edit | edit source]

To store scaled unmerged data in Data reduction - AIMLESS task you need to open Important Options and check:

output unmerged data as well as merged

CCP4 Cloud[edit | edit source]

Saving scaled unmerged data is not supported?

dials.scale[edit | edit source]

To output scaled unmerged MTZ file either add option unmerged_mtz=FILE:

dials.scale symmetrized.expt symmetrized.refl unmerged_mtz=scaled_unmerged.mtz

or use dials.export afterwards:

dials.export scaled.refl scaled.expt

DUI[edit | edit source]

The DIALS User Interface has 8 steps. The last one is export which writes unmerged MTZ file. The option Output Scaled Intensities must be checked (default) to write scaled unmerged data.

HKL2000[edit | edit source]

The 'no merge original index' macro for SCALEPACK produces a non-standard .sca file. It cannot be used, for example, for structure solution in HKL2000, and therefore gives a warning.

iMosflm[edit | edit source]

iMosflm can scale data with Aimless. Scaled unmerged MTZ file is written by default since v7.4.0 (soon to be released). Older versions had option (off by default) to write scaled unmerged data in the SCALEPACK format.

SCALA[edit | edit source]

CCP4 SCALA program got obsoleted in favor of Aimless. It has option OUTPUT UNMERGED.

STARANISO[edit | edit source]

See here for up-to-date details regarding deposition and mmCIF files generated already on the STARANISO server.

XDS / XSCALE[edit | edit source]

Scaled unmerged data from XDS CORRECT and XSCALE is written in the XDS_ASCII.HKL format. The GEMMI converter can use these files directly.

xdsme[edit | edit source]

Uses XDS and outputs scaled unmerged XDS_ASCII.HKL and {image-glob}_pointless.mtz. The latter is converted from the former using Pointless.

xia2[edit | edit source]

Scaled unmerged MTZ file is stored as DataFiles/*_scaled_unmerged.mtz.