mzXML                  package:xcms                  R Documentation

_H_i_g_h-_p_e_r_f_o_r_m_a_n_c_e, _l_o_w-_l_e_v_e_l _a_c_c_e_s_s _t_o _m_z_X_M_L _d_a_t_a _f_i_l_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Functions for low-level access to data in mzXML files.  They have
     been optimized for maximum speed and memory efficiency.

_U_s_a_g_e:

     mzXMLIsFile(filename)
     mzXMLOpen(filename)
     mzXMLClose(mxid)
     mzXMLNumScans(mxid)
     mzXMLRawData(mxid)

_A_r_g_u_m_e_n_t_s:

filename: path to mxXML file

    mxid: mzXML file ID

_D_e_t_a_i_l_s:

     The mechanisms and structure of mzXML files are not discussed
     here, please se the mzXML documentation for more information.

_V_a_l_u_e:

     'mzXMLIsFile' returns 'TRUE' if the referenced file is an mzXML
     file and 'FALSE' otherwise.

     'mzXMLOpen' returns the 'mxid' of the opened file.

     'mzXMLClose' returns the closing status.

     'mzXMLNumScans' returns the number of scans with an msLevel of 1.

     'mzXMLRawData' returns a named list with components 'rt', 'tic',
     'scanindex', 'mz', and 'intensity'.

     An error in any of the functions will return a (negative) integer
     error code.

_A_u_t_h_o_r(_s):

     Colin A. Smith, csmith@scripps.edu

_R_e_f_e_r_e_n_c_e_s:

     mzXML file format: <URL:
     http://sashimi.sourceforge.net/software_glossolalia.html>

