Clojask-io

A Clojure library designed to extend the file support for Clojask. This library can also be used alone to read in and output dataset files.

Installation

Available on Clojars:

APIs

NS: clojask-io.input

read-file

Read in a file as lazy sequence. Optionally, provide size of the file, corresponding output functions.

Supported file types: csv, txt, dat, tsv, tab. The file size can be larger than memory.

Argument	Type	Function	Remarks
path	String	Indicates where to find the file (either on local machine or online)	- For local files, absolute / relative path of the file - For online resources, url of the resources
[format]	String	The format of the file	Will be inferred from the path suffix if not provided. Will imply the separator (sep) based on pre-setting.
[sep]	String / java.util.regex.Pattern (regex)	The separator of each row of the dataset file
[wrap]	String	Wrapper of each value	Sometimes, the file will wrap each value some punctuations, e.g "" / ''. Can remove them automatically by setting this argument. Does not support asymmetric wrappers.
[stat]	Boolean	Whether to get the size of the file	If true, the return value will add a :size key-value pair in unit of bytes. Size value will be nil if cannot be retrieved.
[output]	Boolean	Whether to also return the corresponding output function	If true, the return value will add a :output key-value pair.

Return

{:data a lazy sequence of vectors representing each row [:size the size in byte] [:output output function]}

read-excel

Read in an excel file as lazy sequence. Optionally, provide size of the file.

A simplified wrapper function of Docjure. The excel file should be smaller than memory size.

Argument	Type	Function	Remarks
path	String	Indicates where to find the file (either on local machine or online)	- For local files, absolute / relative path of the file - For online resources, url of the resources
sheet	String	Name
[stat]	Boolean	Whether to get the size of the file	If true, the return value will add a :size key-value pair in unit of bytes. Size value will be nil if cannot be retrieved.

Return

{:data a lazy sequence of vectors representing each row [:size the size in byte]}

infer-format

Infer the file format from the path (get the substring after the last .).

Argument	Type	Function	Remarks
path	String	Indicates where to find the file (either on local machine or online)	- For local files, absolute / relative path of the file - For online resources, url of the resources

Return

String, such as "csv", "xls" (nil if fails to infer)

NS: clojask-io.output

---

Copyright © 2022 Clojask-io