Scautable API
API
Generated with
Scautable API/io.github.quafadas/table

table

io.github.quafadas.table
object table

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
table.type

Members list

Type members

Classlikes

enum HeaderOptions

Options for handling headers in tabular data.

Options for handling headers in tabular data.

This enum provides different strategies for obtaining column headers when reading data from sources like CSV files or Excel spreadsheets.

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HeaderOptions

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
enum ReadAs

Specifies how to read CSV data.

Specifies how to read CSV data.

  • Rows: Returns CsvIterator[K, V] - lazy row-by-row iteration
  • Columns: Returns NamedTuple[K, (Array[T1], Array[T2], ...)] - eager column arrays
  • ArrayDenseColMajor[T]: Returns a single dense array in column-major order
  • ArrayDenseRowMajor[T]: Returns a single dense array in row-major order

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ReadAs

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ReadAs.type
enum TypeInferrer

Enumeration of strategies for inferring column types when reading CSV files.

Enumeration of strategies for inferring column types when reading CSV files.

  • FirstRow: Infers types by inspecting only the first row of data.
  • FirstN: Infers types by inspecting the first n rows. Optionally, prefers Int over Boolean if both are possible.
  • FromAllRows: Infers types by inspecting all rows in the CSV.
  • StringType: Disables type inference; all columns are read as String.
  • FromTuple[T]: Uses a user-supplied tuple type T for decoding, allowing custom or manual type specification.

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TypeInferrer

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Exports

Defined exports

final type BadTableException = BadTableException
Exported from scautable
final val CSV: CSV
Exported from scautable
final type CsvIterator = [K <: Tuple, V <: Tuple] =>> CsvIterator[K, V]
Exported from scautable
final val CsvOpts: CsvOpts
Exported from scautable
final type CsvOpts = CsvOpts
Exported from scautable
final val Excel: Excel
Exported from scautable
final type ExcelIterator = [K <: Tuple, V <: Tuple] =>> ExcelIterator[K, V]
Exported from scautable
final val HtmlRenderer: HtmlRenderer
Exported from scautable
final val JsonTable: JsonTable
Exported from json
final type StatsContext = StatsContext
Exported from Stats$
transparent inline def absolutePath[K](filePath: String, sheetName: String, range: String = ..., inline typeInferrer: TypeInferrer = ...): ExcelIterator[_ <: Tuple, _ <: Tuple]
Exported from Excel

Read Excel file from an absolute path with compile-time type inference

Read Excel file from an absolute path with compile-time type inference

Value parameters

filePath

Absolute path to the Excel file

range

Optional cell range (e.g., "A1:C10"), empty string reads entire sheet

sheetName

Name of the Excel sheet to read

typeInferrer

Type inference strategy (StringType or FromTuple supported)

Attributes

Returns

ExcelIterator with inferred types

inline export excelIntDecoder:
Exported from ExcelDecoders

Decoder for Int that can handle Excel's numeric formatting Attempts to parse as Double first, then converts to Int if it's a whole number Falls back to regular Int parsing if Double parsing fails

Decoder for Int that can handle Excel's numeric formatting Attempts to parse as Double first, then converts to Int if it's a whole number Falls back to regular Int parsing if Double parsing fails

Attributes

inline export excelLongDecoder:
Exported from ExcelDecoders

Decoder for Long that can handle Excel's numeric formatting Attempts to parse as Double first, then converts to Long if it's a whole number Falls back to regular Long parsing if Double parsing fails

Decoder for Long that can handle Excel's numeric formatting Attempts to parse as Double first, then converts to Long if it's a whole number Falls back to regular Long parsing if Double parsing fails

Attributes

transparent inline def projectRoot[K](filePath: String, sheetName: String, inline typeInferrer: TypeInferrer): ExcelIterator[_ <: Tuple, _ <: Tuple]
Exported from Excel
transparent inline def projectRoot[K](filePath: String, sheetName: String, range: String = ..., inline typeInferrer: TypeInferrer = ...): ExcelIterator[_ <: Tuple, _ <: Tuple]
Exported from Excel

Read an Excel file at a path relative to the discovered project root, with compile-time type inference.

Read an Excel file at a path relative to the discovered project root, with compile-time type inference.

The root is the first ancestor of the calling source file holding a build marker (build.mill, build.sbt, .git, ...). In a notebook or REPL there is no source file on disk to search upwards from, so the root is discovered from the working directory instead and a compile time warning says so.

Value parameters

filePath

Path to the Excel file, relative to the project root

range

Optional cell range (e.g., "A1:C10"), empty string reads entire sheet

sheetName

Name of the Excel sheet to read

typeInferrer

Type inference strategy (StringType or FromTuple supported)

Attributes

Returns

ExcelIterator with inferred types

transparent inline def relativeToSource[K](filePath: String, sheetName: String, inline typeInferrer: TypeInferrer): ExcelIterator[_ <: Tuple, _ <: Tuple]
Exported from Excel
transparent inline def relativeToSource[K](filePath: String, sheetName: String, range: String = ..., inline typeInferrer: TypeInferrer = ...): ExcelIterator[_ <: Tuple, _ <: Tuple]
Exported from Excel

Read an Excel file at a path relative to the source file this is called from, with compile-time type inference.

Read an Excel file at a path relative to the source file this is called from, with compile-time type inference.

The path is anchored to the calling source file rather than to the compiler's working directory, so it resolves the same way no matter where the build was invoked from. In a notebook or REPL there is no source file on disk, so the path resolves against the working directory instead and a compile time warning says so.

Value parameters

filePath

Path to the Excel file, relative to the calling source file

range

Optional cell range (e.g., "A1:C10"), empty string reads entire sheet

sheetName

Name of the Excel sheet to read

typeInferrer

Type inference strategy (StringType or FromTuple supported)

Attributes

Returns

ExcelIterator with inferred types

transparent inline def resource[K](filePath: String, sheetName: String): ExcelIterator[_ <: Tuple, _ <: Tuple]
Exported from Excel
transparent inline def resource[K](filePath: String, sheetName: String, inline typeInferrer: TypeInferrer): ExcelIterator[_ <: Tuple, _ <: Tuple]
Exported from Excel
transparent inline def resource[K](filePath: String, sheetName: String, range: String = ..., inline typeInferrer: TypeInferrer = ...): ExcelIterator[_ <: Tuple, _ <: Tuple]
Exported from Excel

Read Excel file from the classpath with compile-time type inference

Read Excel file from the classpath with compile-time type inference

Value parameters

filePath

Path to the Excel file in the classpath

range

Optional cell range (e.g., "A1:C10"), empty string reads entire sheet

sheetName

Name of the Excel sheet to read

typeInferrer

Type inference strategy (StringType or FromTuple supported)

Attributes

Returns

ExcelIterator with inferred types

Generated with