Safeguard against accidental multi-residue swapaa

[Tristan Croll]

The following bug report has been submitted:
Platform:        Linux-3.10.0-1127.19.1.el7.x86_64-x86_64-with-centos-7.8.2003-Core
ChimeraX Version: 1.1 (2020-09-09 22:22:27 UTC)
Description
I've messed myself up a few times in the past by accidentally running swapaa on a selection encompassing multiple residues rather than just the single residue I wanted. Since there is no undo for steps that add or remove atoms, that can be pretty disastrous. I wonder if it would be worth adding an optional argument (multiResidue?) that defaults to false, and if true raises a UserError if more than one residue is selected?

Log:
> alias preview_toolshed toolshed url https://cxtoolshed-
> preview.rbvi.ucsf.edu; toolshed reload available

> alias production_toolshed toolshed url https://cxtoolshed.rbvi.ucsf.edu;
> toolshed reload available

> alias st isolde step $*

> alias aw isolde add water $*

> alias awsf isolde add water sim false

> alias al isolde add ligand $*

> alias so setattr sel atoms occupancy $*

UCSF ChimeraX version: 1.1 (2020-09-09)  
© 2016-2020 Regents of the University of California. All rights reserved.  
How to cite UCSF ChimeraX  

> open 3io0

3io0 title:  
Crystal structure of EtuB from Clostridium kluyveri [more info...]  
  
Chain information for 3io0 #1  
---  
Chain | Description  
A | EtuB protein  
  
3io0 mmCIF Assemblies  
---  
1| author_and_software_defined_assembly  
  

> show

> select :120-158

272 atoms, 274 bonds, 39 residues, 1 model selected  

> swapaa sel ALA

Using Dunbrack library  
Swapping /A ARG 120 to ALA  
  
Swapping /A VAL 121 to ALA  
  
Swapping /A GLY 122 to ALA  
  
Swapping /A ALA 123 to ALA  
  
Swapping /A PRO 124 to ALA  
  
Swapping /A ALA 125 to ALA  
  
Swapping /A GLN 126 to ALA  
  
Swapping /A MET 127 to ALA  
  
Swapping /A MET 128 to ALA  
  
Swapping /A ALA 129 to ALA  
  
Swapping /A ALA 130 to ALA  
  
Swapping /A ASP 131 to ALA  
  
Swapping /A GLU 132 to ALA  
  
Swapping /A ALA 133 to ALA  
  
Swapping /A VAL 134 to ALA  
  
Swapping /A LYS 135 to ALA  
  
Swapping /A GLY 136 to ALA  
  
Swapping /A THR 137 to ALA  
  
Swapping /A ASN 138 to ALA  
  
Swapping /A THR 139 to ALA  
  
Swapping /A GLU 140 to ALA  
  
Swapping /A VAL 141 to ALA  
  
Swapping /A ALA 142 to ALA  
  
Swapping /A THR 143 to ALA  
  
Swapping /A ILE 144 to ALA  
  
Swapping /A GLU 145 to ALA  
  
Swapping /A LEU 146 to ALA  
  
Swapping /A PRO 147 to ALA  
  
Swapping /A ARG 148 to ALA  
  
Swapping /A ASP 149 to ALA  
  
Swapping /A THR 150 to ALA  
  
Swapping /A LYS 151 to ALA  
  
Swapping /A GLY 152 to ALA  
  
Swapping /A GLY 153 to ALA  
  
Swapping /A ALA 154 to ALA  
  
Swapping /A GLY 155 to ALA  
  
Swapping /A HIS 156 to ALA  
  
Swapping /A GLY 157 to ALA  
  
Swapping /A ILE 158 to ALA  
  

> usage swapaa

swapaa residues resType [angleSlop a number] [bfactor a number] [criteria
criteria] [density a density map specifier] [distSlop a number]
[hbondAllowance a number] [ignoreOtherModels true or false] [rotLib rotLib]
[log true or false] [preserve preserve] [relax true or false] [retain true or
false] [scoreMethod scoreMethod] [overlapCutoff a number]  
— Swap amino acid side chain(s)  
resType: a text string  
criteria: some an integer ≥ 0 or a text string  
rotLib: one of Dunbrack, Dynameomics, Richardson.common, or Richardson.mode  
preserve: a number ≥ 0  
scoreMethod: one of num or sum

swapaa interactive residues resType [rotLib rotLib] [log true or false]  
— Show possible side-chain rotamers  
resType: a text string  
rotLib: one of Dunbrack, Dynameomics, Richardson.common, or Richardson.mode

swapaa mousemode residues restype  
— Replace residue with specified amino acid  
restype: one of ALA, ARG, ASN, ASP, CYS, GLN, GLU, GLY, HIS, ILE, LEU, LYS,
MET, PHE, PRO, SER, THR, TRP, TYR, or VAL  




OpenGL version: 3.3.0 NVIDIA 455.32.00
OpenGL renderer: TITAN Xp/PCIe/SSE2
OpenGL vendor: NVIDIA Corporation
Manufacturer: Dell Inc.
Model: Precision T5600
OS: CentOS Linux 7 Core
Architecture: 64bit ELF
CPU: 32 Intel(R) Xeon(R) CPU E5-2687W 0 @ 3.10GHz
Cache Size: 20480 KB
Memory:
	              total        used        free      shared  buff/cache   available
	Mem:            62G        6.5G         39G        263M         16G         55G
	Swap:          4.9G          0B        4.9G

Graphics:
	03:00.0 VGA compatible controller [0300]: NVIDIA Corporation GP102 [TITAN Xp] [10de:1b02] (rev a1)	
	Subsystem: NVIDIA Corporation Device [10de:11df]	
	Kernel driver in use: nvidia
PyQt version: 5.12.3
Compiled Qt version: 5.12.4
Runtime Qt version: 5.12.9
Installed Packages:
    alabaster: 0.7.12
    appdirs: 1.4.4
    Babel: 2.8.0
    backcall: 0.2.0
    blockdiag: 2.0.1
    certifi: 2020.6.20
    chardet: 3.0.4
    ChimeraX-AddH: 2.1.3
    ChimeraX-AlignmentAlgorithms: 2.0
    ChimeraX-AlignmentHdrs: 3.2
    ChimeraX-AlignmentMatrices: 2.0
    ChimeraX-Alignments: 2.1
    ChimeraX-Arrays: 1.0
    ChimeraX-Async: 0.1
    ChimeraX-Atomic: 1.6.1
    ChimeraX-AtomSearch: 2.0
    ChimeraX-AxesPlanes: 2.0
    ChimeraX-BasicActions: 1.1
    ChimeraX-BILD: 1.0
    ChimeraX-BlastProtein: 1.0.1
    ChimeraX-BondRot: 2.0
    ChimeraX-BugReporter: 1.0
    ChimeraX-BuildStructure: 2.0
    ChimeraX-Bumps: 1.0
    ChimeraX-BundleBuilder: 1.0
    ChimeraX-ButtonPanel: 1.0
    ChimeraX-CageBuilder: 1.0
    ChimeraX-CellPack: 1.0
    ChimeraX-Centroids: 1.1
    ChimeraX-ChemGroup: 2.0
    ChimeraX-Clashes: 2.0
    ChimeraX-Clipper: 0.15.0
    ChimeraX-ColorActions: 1.0
    ChimeraX-ColorGlobe: 1.0
    ChimeraX-CommandLine: 1.1.3
    ChimeraX-ConnectStructure: 2.0
    ChimeraX-Contacts: 1.0
    ChimeraX-Core: 1.1
    ChimeraX-CoreFormats: 1.0
    ChimeraX-coulombic: 1.0.1
    ChimeraX-Crosslinks: 1.0
    ChimeraX-Crystal: 1.0
    ChimeraX-DataFormats: 1.0
    ChimeraX-Dicom: 1.0
    ChimeraX-DistMonitor: 1.1
    ChimeraX-DistUI: 1.0
    ChimeraX-Dssp: 2.0
    ChimeraX-EMDB-SFF: 1.0
    ChimeraX-ExperimentalCommands: 1.0
    ChimeraX-FileHistory: 1.0
    ChimeraX-FunctionKey: 1.0
    ChimeraX-Geometry: 1.1
    ChimeraX-gltf: 1.0
    ChimeraX-Graphics: 1.0
    ChimeraX-Hbonds: 2.0
    ChimeraX-Help: 1.0
    ChimeraX-HKCage: 1.3
    ChimeraX-IHM: 1.0
    ChimeraX-ImageFormats: 1.0
    ChimeraX-IMOD: 1.0
    ChimeraX-IO: 1.0
    ChimeraX-ISOLDE: 1.1.0
    ChimeraX-Label: 1.0
    ChimeraX-LinuxSupport: 1.0
    ChimeraX-ListInfo: 1.0
    ChimeraX-Log: 1.1.1
    ChimeraX-LookingGlass: 1.1
    ChimeraX-Map: 1.0.1
    ChimeraX-MapData: 2.0
    ChimeraX-MapEraser: 1.0
    ChimeraX-MapFilter: 2.0
    ChimeraX-MapFit: 2.0
    ChimeraX-MapSeries: 2.0
    ChimeraX-Markers: 1.0
    ChimeraX-Mask: 1.0
    ChimeraX-MatchMaker: 1.1
    ChimeraX-MDcrds: 2.0
    ChimeraX-MedicalToolbar: 1.0.1
    ChimeraX-Meeting: 1.0
    ChimeraX-MLP: 1.0
    ChimeraX-mmCIF: 2.2
    ChimeraX-MMTF: 2.0
    ChimeraX-Modeller: 1.0
    ChimeraX-ModelPanel: 1.0
    ChimeraX-ModelSeries: 1.0
    ChimeraX-Mol2: 2.0
    ChimeraX-Morph: 1.0
    ChimeraX-MouseModes: 1.0
    ChimeraX-Movie: 1.0
    ChimeraX-Neuron: 1.0
    ChimeraX-Nucleotides: 2.0
    ChimeraX-OpenCommand: 1.2.1
    ChimeraX-PDB: 2.1
    ChimeraX-PDBBio: 1.0
    ChimeraX-Phenix: 0.1
    ChimeraX-PickBlobs: 1.0
    ChimeraX-Positions: 1.0
    ChimeraX-PresetMgr: 1.0
    ChimeraX-PubChem: 2.0
    ChimeraX-Read-Pbonds: 1.0
    ChimeraX-Registration: 1.1
    ChimeraX-RemoteControl: 1.0
    ChimeraX-ResidueFit: 1.0
    ChimeraX-RestServer: 1.0
    ChimeraX-RNALayout: 1.0
    ChimeraX-RotamerLibMgr: 2.0
    ChimeraX-RotamerLibsDunbrack: 2.0
    ChimeraX-RotamerLibsDynameomics: 2.0
    ChimeraX-RotamerLibsRichardson: 2.0
    ChimeraX-SaveCommand: 1.2
    ChimeraX-SchemeMgr: 1.0
    ChimeraX-SDF: 2.0
    ChimeraX-Segger: 1.0
    ChimeraX-Segment: 1.0
    ChimeraX-SeqView: 2.2
    ChimeraX-Shape: 1.0.1
    ChimeraX-Shell: 1.0
    ChimeraX-Shortcuts: 1.0
    ChimeraX-ShowAttr: 1.0
    ChimeraX-ShowSequences: 1.0
    ChimeraX-SideView: 1.0
    ChimeraX-Smiles: 2.0
    ChimeraX-SmoothLines: 1.0
    ChimeraX-SpaceNavigator: 1.0
    ChimeraX-StdCommands: 1.0.4
    ChimeraX-STL: 1.0
    ChimeraX-Storm: 1.0
    ChimeraX-Struts: 1.0
    ChimeraX-Surface: 1.0
    ChimeraX-SwapAA: 2.0
    ChimeraX-SwapRes: 2.0
    ChimeraX-TapeMeasure: 1.0
    ChimeraX-Test: 1.0
    ChimeraX-Toolbar: 1.0
    ChimeraX-ToolshedUtils: 1.0
    ChimeraX-Tug: 1.0
    ChimeraX-UI: 1.2.3
    ChimeraX-uniprot: 2.0
    ChimeraX-ViewDockX: 1.0
    ChimeraX-Vive: 1.1
    ChimeraX-VolumeMenu: 1.0
    ChimeraX-VTK: 1.0
    ChimeraX-WavefrontOBJ: 1.0
    ChimeraX-WebCam: 1.0
    ChimeraX-WebServices: 1.0
    ChimeraX-Zone: 1.0
    colorama: 0.4.3
    comtypes: 1.1.7
    cxservices: 1.0
    cycler: 0.10.0
    Cython: 0.29.20
    decorator: 4.4.2
    distlib: 0.3.1
    distro: 1.5.0
    docutils: 0.16
    filelock: 3.0.12
    funcparserlib: 0.3.6
    grako: 3.16.5
    graphviz: 0.14.1
    h5py: 2.10.0
    html2text: 2020.1.16
    idna: 2.10
    ihm: 0.16
    imagecodecs: 2020.5.30
    imagecodecs-lite: 2020.1.31
    imagesize: 1.2.0
    ipykernel: 5.3.0
    ipython: 7.15.0
    ipython-genutils: 0.2.0
    jedi: 0.17.2
    Jinja2: 2.11.2
    jupyter-client: 6.1.3
    jupyter-core: 4.6.3
    kiwisolver: 1.2.0
    line-profiler: 2.1.2
    lxml: 4.5.1
    MarkupSafe: 1.1.1
    matplotlib: 3.2.1
    msgpack: 1.0.0
    netifaces: 0.10.9
    networkx: 2.4
    numexpr: 2.7.1
    numpy: 1.18.5
    numpydoc: 1.0.0
    objgraph: 3.4.1
    openvr: 1.12.501
    packaging: 20.4
    ParmEd: 3.2.0
    parso: 0.7.1
    pexpect: 4.8.0
    pickleshare: 0.7.5
    Pillow: 7.1.2
    pip: 20.2.2
    pkginfo: 1.5.0.1
    prompt-toolkit: 3.0.7
    psutil: 5.7.0
    ptyprocess: 0.6.0
    pycollada: 0.7.1
    pydicom: 2.0.0
    Pygments: 2.6.1
    PyOpenGL: 3.1.5
    PyOpenGL-accelerate: 3.1.5
    pyparsing: 2.4.7
    PyQt5-commercial: 5.12.3
    PyQt5-sip: 4.19.19
    PyQtWebEngine-commercial: 5.12.1
    python-dateutil: 2.8.1
    pytz: 2020.1
    pyzmq: 19.0.2
    qtconsole: 4.7.4
    QtPy: 1.9.0
    RandomWords: 0.3.0
    requests: 2.24.0
    scipy: 1.4.1
    Send2Trash: 1.5.0
    SEQCROW: 0.24.3
    setuptools: 49.4.0
    sfftk-rw: 0.6.6.dev0
    six: 1.15.0
    snowballstemmer: 2.0.0
    sortedcontainers: 2.2.2
    Sphinx: 3.1.1
    sphinxcontrib-applehelp: 1.0.2
    sphinxcontrib-blockdiag: 2.0.0
    sphinxcontrib-devhelp: 1.0.2
    sphinxcontrib-htmlhelp: 1.0.3
    sphinxcontrib-jsmath: 1.0.1
    sphinxcontrib-qthelp: 1.0.3
    sphinxcontrib-serializinghtml: 1.1.4
    suds-jurko: 0.6
    tables: 3.6.1
    tifffile: 2020.6.3
    tinyarray: 1.2.2
    tornado: 6.0.4
    traitlets: 5.0.4
    urllib3: 1.25.10
    versioneer: 0.18
    wcwidth: 0.2.5
    webcolors: 1.11.1
    wheel: 0.34.2

[pett]

In this situation, I could raise a confirmation dialog in GUI mode (and not a script) and just go ahead in non-GUI mode.

[pett]

swapaa now asks for confirmation before swapping multiple residues

[Tristan Croll]

Would it be possible for swapaa mousemode to do the same? I just did a mis-type (didn't notice that the previous command hadn't properly cleared, and typed "sel #1" in the middle of it... somehow "sel :410sel #1; view sel; swapaa mouse sel ASP" was still parsed and caused the whole model to be selected; ChimeraX is now hung while it presumably works through converting 3,736 residues to ASP (on a model with an hour or two of unsaved - albeit fairly easy to repeat - work).

[pett]

Tom implemented the "swapaa mousemode" command. The relevant diff to the "regular" swapaa command was:

--- a/src/bundles/swap_res/src/cmd.py
+++ b/src/bundles/swap_res/src/cmd.py
@@ -21,6 +21,13 @@ def swap_aa(session, residues, res_type, *, angle_slop=None, bfactor=None, crite

residues = _check_residues(residues)

+ if len(residues) > 2 and session.ui.is_gui and not session.in_script:
+ from chimerax.ui.ask import ask
+ if ask(session, "Really swap side chains for %d residues?" % len(residues),
+ title="Confirm Swap") == "no":
+ from chimerax.core.errors import CancelOperation
+ raise CancelOperation("Swap %d side chains cancelled" % len(residues))
+

if type(criteria) == str:

for c in criteria:

if c not in "dchp":