FreeSASAcheck: FreeSASA Check

In vanddraabe: Identification and Statistical Analysis of Conserved Waters Near Proteins

Description

Determines if FreeSASA is (correctly) installed.

Usage

FreeSASAcheck()

Details

Because FreeSASA is NOT included with vanddraabe it is important to ensure the application has been installed and was correctly compiled.

Value

When FreeSASA is correctly installed the current version and citation are returned to the user:

FreeSASA 2.0
License: MIT <http://opensource.org/licenses/MIT>
If you use this program for research, please cite:
  Simon Mitternacht (2016) FreeSASA: An open source C
  library for solvent accessible surface area calculations.
F1000Research 5:189.

When FreeSASA is NOT correctly installed the following are returned to the user:

Error in FreeSASAcheck() :
Uh-oh!!
Please make sure FreeSASA is correctly installed! Please visit
(http://freesasa.github.io) for
instructions specific to your operating system.

Author(s)

Emilio Xavier Esposito [e-mail]

References

Simon Mitternacht. FreeSASA: An open source C library for solvent accessible surface area calculations [version 1; referees: 2 approved]. F1000Research, 2016, 5:189 DOI: 10.12688/f1000research.7931.1 PMCID: PMC4776673 FreeSASA

See Also

Other "vanddraabe utilities": ConservedWaterStats

Examples

## Not run: 
  # Result for correct installation
  FreeSASAcheck()
  # FreeSASA 2.0
  # License: MIT <http://opensource.org/licenses/MIT>
  # If you use this program for research, please cite:
  #   Simon Mitternacht (2016) FreeSASA: An open source C
  #   library for solvent accessible surface area calculations.
  #   F1000Research 5:189.
  #
  # Report bugs to <https://github.com/mittinatten/freesasa/issues>
  # Home page: <http://freesasa.github.io>
  #
  # Congratulations! FreeSASA is correctly installed!
  #
  # Result for incorrect installation
  FreeSASAcheck()
  # Error:
  # Uh-oh!!
  # Please make sure FreeSASA is correctly installed. Please visit
  # http://freesasa.github.io for instructions specific to your operating
  # system.

## End(Not run)

vanddraabe documentation built on June 8, 2019, 1:03 a.m.