LIBPWIZ(3)

πŸ“¦ version 3.0.18342, in debian bookworm, ubuntu jammy, ubuntu noble, ubuntu resolute

πŸ’– LIBPWIZ πŸ’–

okay bestie, so this is the manual page for libpwiz(3) β€” a library function from the Library Functions Manual. It's giving "proteomics girlies rise up" and I'm obsessed. Let's get into it. 🧚✨


🌸 NAME 🌸

libpwiz β€” the library that does proteomics data analyses (runtime edition, no cap) πŸ’…


✨ DESCRIPTION ✨

So real quick, this page documents the libpwiz package β€” and yes the original says it "brings a library library," which is the most iconic typo situation ever, we're keeping that energy. It's a library that lets you do proteomics data analyses. πŸ¦‹

ProteoWizard provides a modular and extensible set of open-source, cross-platform tools and libraries. The tools perform proteomics data analyses; the libraries enable rapid tool creation by providing a robust, pluggable development framework that simplifies and unifies data file access, and performs standard chemistry and LCMS dataset computations. It's literally the main character of your data pipeline. πŸ‘‘


πŸŽ€ EXAMPLES OF BINARIES β€” -Ipwiz/data/msdata/ramp πŸŽ€

All these programs (in `/usr/lib/libpwizX/example-files' could be built using the command line shown after the binary name. Yes, the original's parentheses and quote marks are a lil unhinged, we're not touching them, they're iconic. πŸ’€

  • mscat β€” build it with:
g++ -I /usr/include/libpwiz -l pwiz mscat.cpp -o mscat
  • hello_analyzer_2 β€” build it with:
g++ -I /usr/include/libpwiz -l pwiz hello_analyzer_2.cpp -o hello_analyzer_2
  • hello_analyzer β€” build it with:
g++ -I /usr/include/libpwiz -l pwiz hello_analyzer.cpp -o hello_analyzer
  • hello_msdata β€” build it with:
g++ -I /usr/include/libpwiz -l pwiz hello_msdata.cpp -o hello_msdata
  • txt2mzml β€” build it with:
g++ -I /usr/include/libpwiz -l pwiz -l boost_filesystem -l boost_system txt2mzml.cpp -o txt2mzml
  • hello_ramp β€” build it with:
g++ -I /usr/include/libpwiz -I /usr/include/libpwiz/pwiz/data/msdata/ramp -l pwiz hello_ramp.cpp -o hello_ramp
  • write_example_files β€” build it with:
g++ -I /usr/include/libpwiz -l pwiz write_example_files.cpp -o write_example_files
  • write_mzid_example_files β€” build it with:
g++ -I /usr/include/libpwiz -l pwiz write_mzid_example_files.cpp -o write_mzid_example_files
  • write_proteome_example_files β€” build it with:
g++ -I /usr/include/libpwiz -l pwiz write_proteome_example_files.cpp -o write_proteome_example_files
  • write_traml_example_files β€” build it with:
g++ -I /usr/include/libpwiz -l pwiz write_traml_example_files.cpp -o write_traml_example_files

✨ so what do those flags actually mean, bestie? The -I /usr/include/libpwiz specifies the location of the include files for the whole proteowizard project. The -l pwiz specifies the libpwiz library to be linked-in so as to build the binaries. Slay. πŸ”₯


πŸ“š BIBLIOGRAPHICAL REFERENCE TO BE CITED πŸ“š

ok so if you're citing this in your paper (and you SHOULD, it's the polite thing to do), here's the full glow-up of an author list. Copy it exactly, bestie, no shortcuts. 🫢

Chambers, M.C., MacLean, B., Burke, R., Amode, D., Ruderman, D.L., Neumann, S., Gatto, L., Fischer, B., Pratt, B., Egertson, J., Hoff, K., Kessner, D., Tasman, N., Shulman, N., Frewen, B., Baker, T.A., Brusniak, M.-Y., Paulse, C., Creasy, D., Flashner, L., Kani, K., Moulding, C., Seymour, S.L., Nuwaysir, L.M., Lefebvre, B., Kuhlmann, F., Roark, J., Rainer, P., Detlev, S., Hemenway, T., Huhmer, A., Langridge, J., Connolly, B., Chadick, T., Holly, K., Eckels, J., Deutsch, E.W., Moritz, R.L., Katz, J.E., Agus, D.B., MacCoss, M., Tabb, D.L. & Mallick, P. (2012) A cross-platform toolkit for mass spectrometry and proteomics. Nature Biotechnology, 30. 10.1038/nbt.2377.


πŸ‘€ SEE ALSO πŸ‘€

The library is documented fully in the doxygen-extacted documentation that is packaged in libpwiz-doc. Go read it, it's giving "everything you ever wanted to know." 🌈


πŸ’œ AUTHOR πŸ’œ

This manual page was written by Filippo Rusconi <lopippo@debian.org>.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3, published by the Free Software Foundation.

On a Debian system the complete text of the GNU General Public License version 3 can be found in the file `/usr/share/common-licenses/GPL-3'.

and that's the whole page, bestie πŸŽ€ this was the October 2012 edition of LIBPWIZ(3), straight out of the Library Functions Manual. mwah πŸ’‹ go build something iconic with it. πŸ’…βœ¨πŸ¦‹

πŸ“¦ where this page comes from