# Quick Start Guide

#### 2020-10-27

# Introduction

Isoreader supports various dual inlet, continuous flow, and scan file formats. This vignette shows how to get started reading these raw IRMS data files and exporting the information to Excel. For more details on isoreader functionality and each file type, please read the Full Examples vignettes. For more information on downstream processing with isoverse, check out the isoprocessor package.

    # load isoreader package
    library(isoreader)

# Data files

For demonstration purposes, this vignette simply reads all supported dual inlet, continuous flow, and scan files that are bundled with the isoreader package.

    # all available examples
    iso_get_reader_examples() %>% rmarkdown::paged_table()

# Dual Inlet Files

    # read all available examples
    di_files <- iso_read_dual_inlet(iso_get_reader_examples_folder())
    #> Info: preparing to read 3 data files (all will be cached)...
    #> Info: reading file 'dual_inlet_example.caf' from cache...
    #> Info: reading file 'dual_inlet_example.did' from cache...
    #> Info: reading file 'dual_inlet_nu_example.txt' from cache...
    #> Info: finished reading 3 files in 0.26 secs

    # save as r data storage (read back in with iso_read_dual_inlet)
    iso_save(di_files, filepath = "di_save")
    #> Info: exporting data from 3 iso_files into R Data Storage 'di_save.di.rds'

    # export to excel
    iso_export_to_excel(di_files, filepath = "di_export")
    #> Info: exporting data from 3 iso_files into Excel 'di_export.di.xlsx'
    #> Info: aggregating all data from 3 data file(s)

# Continuous Flow Files

    # read all available examples
    cf_files <- iso_read_continuous_flow(iso_get_reader_examples_folder())
    #> Info: preparing to read 3 data files (all will be cached)...
    #> Info: reading file 'continuous_flow_example.cf' from cache...
    #> Info: reading file 'continuous_flow_example.dxf' from cache...
    #> Info: reading file 'continuous_flow_example.iarc' from cache...
    #> Info: finished reading 3 files in 0.16 secs

    # save as r data storage (read back in with iso_read_continuous_flow)
    iso_save(cf_files, filepath = "cf_save")
    #> Info: exporting data from 6 iso_files into R Data Storage 'cf_save.cf.rds'

    # export to excel
    iso_export_to_excel(cf_files, filepath = "cf_export")
    #> Info: exporting data from 6 iso_files into Excel 'cf_export.cf.xlsx'
    #> Info: aggregating all data from 6 data file(s)

# Scan Files

    # read all available examples
    scan_files <- iso_read_scan(iso_get_reader_examples_folder())
    #> Info: preparing to read 4 data files (all will be cached)...
    #> Info: reading file 'background_scan_example.scn' with '.scn' reader...
    #> Info: reading file 'full_scan_example.scn' with '.scn' reader...
    #> Info: reading file 'peak_shape_scan_example.scn' with '.scn' reader...
    #> Info: reading file 'time_scan_example.scn' with '.scn' reader...
    #> Info: finished reading 4 files in 0.79 secs

    # save as r data storage (read back in with iso_read_scan)
    iso_save(scan_files, filepath = "scan_save")
    #> Info: exporting data from 4 iso_files into R Data Storage 'scan_save.scan.rds'

    # export to excel
    iso_export_to_excel(scan_files, filepath = "scan_export")
    #> Info: exporting data from 4 iso_files into Excel 'scan_export.scan.xlsx'
    #> Info: aggregating all data from 4 data file(s)