freesasa(1)

πŸ“¦
version 2.1.2 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– NAME πŸ’–

FreeSASA β€” calculate Solvent Accessible Surface Areas from PDB files ✨


🌸 SYNOPSIS 🌸

freesasa PDB-FILE ... [ --shrake-rupley | --lee-richards
    --probe-radius=NUMBER
    --resolution=INTEGER --n-threads=INTEGER
    --radius-from-occupancy | --config-file=FILE |
--radii=protor|naccess
    --separate-models | --join-models
    --hetatm --hydrogen
    --separate-chains | --chain-groups=STRING ...
    --unknown=guess|skip|halt
    --cif
    --output=FILE --error-file=FILE --no-warnings
    --select=STRING ...
    --format=log|res|seq|pdb|rsa|xml|json ...
    --depth=structure|chain|residue|atom ]

freesasa [options] < PDB-FILE

freesasa (--help | --version | --deprecated)

so basically bestie, there's three whole ways to call this thing πŸ‘‘

  1. Hand it one or more PDB-FILE arguments plus whatever options you're feeling, and it goes off πŸ’…
  2. Feed the PDB in on stdin with < PDB-FILE and pass your [options] 🫢
  3. Just vibe-check it with --help, --version, or the nostalgic --deprecated ✨

πŸ¦‹ DESCRIPTION πŸ¦‹

Calculate the Solvent Accessible Surface Area (SASA) of biomolecules from PDB files, using either Lee & Richards' algorithm or Shrake & Rupley's algorithm. Pick your fighter, no cap πŸ’€

Report bugs to: https://github.com/mittinatten/freesasa/issues

Home page: http://freesasa.github.io

fr fr if something's broken, tell the maintainers, don't just suffer in silence πŸ₯Ί

πŸ‘‘ OPTIONS πŸ‘‘

πŸŽ€ Parameters

  • -S, --shrake-rupley β€” Use the Shrake & Rupley algorithm.
  • -L, --lee-richards β€” Use the Lee & Richards algorithm. [default] β€” this one's the main character unless you say otherwise πŸ‘‘
  • -p, --probe-radius NUMBER β€” Set the probe radius, in Angstroms. [default: 1.40 Γ…]
  • -n, --resolution INTEGER β€” Set the resolution for the calculation. It's giving depends who you ask:
    • S&R: number of test points per atom [default: 100]
    • L&R: slices per atom [default: 20]
  • -t, --n-threads INTEGER β€” Number of threads to use. [default: 2] β€” multitasking queen 🧚

πŸ“ Atom radii and classes (maximum one of the following)

listen. maximum one. not two, not three. pick a lane bestie 🫢
  • -O, --radius-from-occupancy β€” Read the atomic radii from the Occupancy column in the PDB input.
  • -c, --config-file FILE β€” Classifier to determine radii and classes. Example files live in 'share/' πŸ“
  • --radii protor|naccess β€” Use either ProtOr or NACCESS radii and classes. [default: protor]

πŸ’œ Input options

  • --cif β€” Input is in mmCIF format.
  • -H, --hetatm β€” Include HETATM entries from the input.
  • -Y, --hydrogen β€” Include hydrogen atoms. Suppress the warnings with -w (because it will be noisy, iykyk πŸ™ˆ).
  • -m, --join-models β€” Join all MODELs in the input into one single structure.
  • -C, --separate-chains β€” Calculate SASA for each chain separately.
  • -M, --separate-models β€” Calculate SASA for each MODEL separately.
  • --unknown guess|skip|halt β€” When an unknown atom shows up, either guess its radius/class, skip it, or halt. [default: guess] β€” choose your adventure ✨
  • -g, --chain-groups LIST β€” Each group will be treated separately.

Examples:

'-g A', '-g A+B', '-g A -g B', '-g AB+CD'

🌈 Output options

  • -w, --no-warnings β€” Skip most warnings. living your peace era πŸ•ŠοΈ
  • -o, --output FILE β€” Output file.
  • -e, --error-file FILE β€” Redirect errors and warnings to a file.
  • -f, --format log|res|seq|pdb|rsa|cif|xml|json β€” Output format. Can be repeated. [default: log] β€” yes you can stack them, greedy little icon πŸ’…
  • -d, --depth structure|chain|residue|atom β€” Depth of the JSON and XML output. [default: chain]
  • --select COMMAND β€” Select atoms using Pymol select syntax. Can be repeated.

Examples:

--select "AR, resn ala+arg", --select "chain_A, chain A"

πŸ’€ Deprecated

These options have been replaced and will disappear in later versions. Use them while you can, but don't get attached 😭

  • --rsa β€” Equivalent to --format=rsa.
  • -B, --print-as-B-values β€” Equivalent to --format=pdb.
  • -r, --foreach-residue-type β€” Equivalent to --format=res.
  • -R, --foreach-residue β€” Equivalent to --format=seq.
  • -l, --no-log β€” Log suppressed if another format is selected. This option has no effect. literally nothing. a ghost. 🫠

and that's the whole page bestie, go calculate some surfaces πŸ¦‹βœ¨

freesasa(1) β€” version 2.1.2, dated 2017, from the FreeSASA man page. mwah, take care of her πŸ’–πŸŽ€

πŸ“¦ where this page comes from