Releases: ethanbass/chromConverter
Releases · ethanbass/chromConverter
v0.7.1
chromConverter 0.7.1
- Fixed automatic file detection for directories (e.g., Waters
.raw
and Agilent.D
) - Fixed bug preventing extraction of
Waters
chromatograms with lowercase filenames. - Added support for extracting metadata from 'Waters'
.raw
header files. - Added support for extraction of detector units from 'Waters' chromatograms.
0.7.0
chromConverter 0.7.0
Major features
- Added preliminary support for 'Varian Worktation' (
.sms
) format throughread_varian_sms
function. - Added preliminary support for 'Shimadzu QGD' GCMS files through the
read_shimadzu_qgd
function. - Added preliminary support for 'Allotrope Simple Model' (ASM) 2D chromatography date files.
- Added support for reading multiple files from 'Agilent'
.D
directories throughread_agilent_d
function. - Added internal parser for 'Agilent ChemStation' MS files through
read_agilent_ms
. - Added option to write mzML files (MS1 and DAD).
- Added option to write ANDI MS netCDF files.
UI changes
- Changed order of arguments in
read_chroms
so thatformat_in
comes second afterpath
. - Removed extraneous
export
argument fromread_chroms
. To export files, you now only need to provide an argument toexport_format
. - Updated handling of multiple chromatograms by
read_shimadzu_lcd
. The function now returns a list of named chromatograms ifdata_format == "wide"
and returns multiple chromatograms in a singledata.frame
ifdata_format == "long"
. - Added
scale
argument toread_chemstation_uv
andread_shimadzu_ascii
to toggle scaling of chromatograms. - Harmonized file path arguments across parser functions by changing
file
arguments topath
. - Harmonized column names in output across parsers.
- Small changes in
read_cdf
UI:what
now defaults toNULL
and defaults are coded into downstreamread_andi_chrom
andread_andi_ms
functions. - Added extra verbosity in
read_chroms
whenverbose
isTRUE
.
Other improvements
- Fixed bug causing reticulate to attempt reinstallation of Aston every time the package is loaded (due to case sensitivity of packages names in
reticulate::configure_environment
). - Added
data.table
as an option forformat_out
. - Improved speed of
read_shimadzu_lcd
by dealing with twos-complements more sensibly. - Start 'Shimadzu LCD' chromatogram retention times at dwell time (DLT).
- Give temp files generated from Shimadzu OLE files informative names.
- Use 'Output Date' field instead of 'Type' to find 'Shimadzu' ASCII delimiter. (This seems to be a more generalizable solution since some files do not contain the 'Type' field).
- Allow relative paths for
path_out
when using 'ThermoRawFileParser' and 'OpenChrom' parsers. - Allow creation of new directories by
read_chroms
ifpath_out
does not exist. - Fixed bug affecting some
mdf
files lacking null bytes after the file header. - Eliminated 'magrittr' dependency by using xpath to parse XML in a more straightforward fashion.
- Fixed bug causing truncation of sample names at the first period by
read_chroms
. - Modified
export_csv
function to label first column for wide-format chromatograms. - Improved handling of metadata from rainbow parsers.
- Fixed error when providing single chromatogram to \code{extract_metadata}.
- Added metadata field for source checksum (SHA1) and source file format.
- Other minor changes to metadata fields.
- Return all times in Coordinated Univeral Time (UTC) for consistency across systems.
chromConverter 0.6.4
- Added support for 'Agilent ChemStation' version 8 (
.ch
) files throughread_chemstation_ch
. - Fixed failure to return units in some
Agilent Chemstation
files due to typo. - Fixed bug causing "spill-over" of Agilent metadata fields.
- Fixed bug causing failure to read
ChemStation
CSV files on (some) mac machines by specifying little-endian format in call toread.csv
.
chromConverter 0.6.3
- Added parser for total ion chromatogram (TIC) stream in 'Shimadzu' LCD files.
- Added additional support for extraction of metadata from 'Shimadzu' LCD and GCD files.
- Updated docs for
read_shimadzu_lcd_2d
to more accurately reflect file structure. - Added
scale
argument toread_chemstation_ch
andread_shimadzu_lcd
to
toggle scaling of chromatograms resolving (#30).
chromConverter 0.6.2
- Updated
read_shimadzu_lcd
function to correctly determine the number of blocks in the "Shimadzu" LCD PDA stream (thanks to kco-hereon). - Added preliminary support for 2D data streams from "Shimadzu LCD" files.
- Added parser for 'Shimadzu GCD' files (from GC-FID).
v0.6.1
chromConverter 0.6.1
- Added support for 'Shimadzu ascii' files with '[LC Chromatogram...]' sub-header.
- Correct 'Shimadzu ascii' chromatograms by 'Intensity Multiplier' if it is provided.
- Minor, cosmetic changes to documentation.
- Fixed bug in logic in
export_cdfs
function to permit conversion of files lacking metadata.
v0.6.0
chromConverter 0.6.0
- Added parser for reading ANDI MS (
.cdf
) files. - Fixed parsing of Agilent MS files with 'entab' reader.
- Fixed
read_chemstation_ch
parser to correctly read "Mustang Chemstation" 179 files with 8-byte encoding. - Re-factored
read_shimadzu
function and added support for new types of chromatograms (e.g. status, uv and total ion chromatograms). Added support for reading multiple types of chromatograms at once. - Added support for reading MS spectra from 'Shimadzu' ascii files using
read_shimadzu
. - Exported
write_cdf
and added additional arguments (lambda
andforce
) for greater control by users. - Added internal parser for 1D 'Waters RAW' chromatograms (
read_waters_raw
). - Added
collapse
argument tocall_rainbow
and to collapse superfluous lists. - Added
...
argument toread_chroms
for supplying additional arguments to parsers. - Added alias to
read_chroms
for readingmzxml
files withRaMS
. - Added
precision
argument tocall_rainbow
to control number of digits "mz" values are rounded to. (Also changed default behavior so values are rounded to one decimal by default). - Fixed bug in
read_shimadzu_lcd
on Windows due to issue with passing escaped paths to Python. - Updated documentation of various functions.
v0.5.0
chromConverter 0.5.0
New features
- Added support for parallel processing through
pbapply
package. (Note: Thepbapply
package must be manually installed to enable parallel processing). - Added internal parser for 'Agilent Chemstation' version 31 files (through
read_chemstation_uv
function). - Added support for 'Agilent OpenLab' version 131 files through internal parser.
- Added preliminary support for reading 'Agilent' (
.dx
) files (throughread_agilentdx
function). - Added support for reading 'Chemstation' REPORT files.
- Added parser for Shimadzu
.lcd
files through theread_shimadzu_lcd
function. Only the PDA stream (not MS) is currently supported. - Added
read_peaklist
function for reading peak lists. Currently 'Agilent Chemstation' and 'Shimadzu ASCII' formats are supported. - Added
verbose
argument to control console output for external parsers ('OpenChrom' and 'ThermoRawFileParser').
Other Improvements
- Improved automatic filetype detection by
read_chroms
. - Refactored
read_thermoraw
function to simplify paths. - The
thermoraw
andopenchrom
parsers now use a proper temp directory if an export directory is not specified through thepath_out
argument. - Re-factored
reshape_chroms
, speeding up conversion from wide to long format. - Added additional tests, attaining 82% test coverage.
- Changed default
openchrom
export format tomzml
. - Minor changes to some metadata fields to better standardize results across different file formats and parsers.
v0.4.3
v0.4.2
v0.4.1
chromConverter 0.4.1
New features
- Added support for "Chemstation" UV (
.ch
) files (version 30).
Minor improvements
- Updated
read_chromeleon
to better deal with comma decimal separators in metadata. - Updated
read_chromeleon
to deal with more datetime formats. - Updated
read_chromeleon
to deal with unicode microliters. - Added tests for rainbow parser and
read_chemstation_ch
.
Bug fixes
- Fixed bug preventing compilation of PDF manual.
- Fixed new bug causing failure to correctly read names of chemstation files from .D directory.
v0.4.0
chromConverter 0.4.0
New features
- Added parser for ANDI chrom
cdf
files through theread_cdf
function. - Added parser for 'Lumex'
.mdf
files through theread_mdf
function. - Added additional options for file exports. New options for writing
chemstation_csv
(utf-16) and ANDI chromcdf
files throughread_chroms
. - Added preliminary support for automatic filetype detection by
read_chroms
when providing direct paths to files (i.e. whenfind_files == FALSE
). - Added
read_varian_peaklist
function for reading peak lists from 'Varian MS Workstation'.
Other improvements and bug fixes:
- Added
wide
andlong
data_format
options for 2D data, such that thewide
format option writes retention times as rownames of the matrix or data.frame. while thelong
format writes retention times as the first column of the object. - Updated
configure_openchrom
for better discovery of 'OpenChrom' path and addedpath
argument for directly specifying the path to 'OpenChrom'. - Slightly restructured metadata fields. Added
source_file
field to track
data origin. - Standardized datetime stamps so they are always converted to POSIXct format.
- Now use
fs
package for parsing paths, eliminating buggycheck_paths
function. - Fixed bug causing sloppy 'Chemstation' FID metadata.
- Fixed bug that caused padding of 'Chemstation 130' files with extra zeros.
- Added additional tests.
v0.3.3
chromConverter 0.3.3
- Added R-based parser for "Chemstation" UV (
.uv
) files (version 131) through
theread_chemstation_uv
function. - Added
extract_metadata
function for extracting metadata from a list of chromatograms
and returning it as adata.frame
ortibble
. - Added
progress_bar
option inread_chroms
. - Updated
reshape_chroms
andreshape_chrom
to allow switching between "wide" and "long" formats. - Added wide format option in
read_mzml
. - Added automatic detection of file formats by
read_chroms
. - Minor changes to storage of metadata in attributes for the purpose of simplification.
- Minor updates to documentation.