diff --git a/README.md b/README.md index 0c52247..3b324df 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,44 @@ Jupyter notebook providing VTL support through Trevas engine Custom functions have been introduced into the Trevas engine. | Name | Arguments | Description | -| ------------ | ------------------------ | ------------------------------------ | +|--------------|--------------------------|--------------------------------------| | loadParquet | String url | Load Parquet dataset | -| loadCSV | String url | Load CSV dataset | +| loadCSV (1) | String url | Load CSV dataset | | loadSas | String url | Load Sas dataset | | writeParquet | (String url, Dataset ds) | Write given dataset in Parquet | -| writeCSV | (String url, Dataset ds) | Write given dataset in CSV | +| writeCSV (2) | (String url, Dataset ds) | Write given dataset in CSV | | show | Dataset ds | Display firt rows of a given dataset | | showMetadata | Dataset ds | Display metadata of a given dataset | | size | Dataset ds | Display size of a given dataset | + +### (1) loadCSV + +Default option values: + +| Name | Value | +|:-----------:|:-------:| +| header | true | +| delimiter | ; | +| quote | " | + +Any CSV option can be defined or overridden thanks to url parameters (values have to be encoded). + +For instance, to read a CSV content where delimiter is `|` and quote is `'`: + +`loadCSV(...?delimiter=%7C"e=%27)` + +### (2) writeCSV + +Default option values: + +| Name | Value | +|:-----------:|:-------:| +| header | true | +| delimiter | ; | +| quote | " | + +Any CSV option can be defined or overridden thanks to url parameters (values have to be encoded). + +For instance, to write a CSV with a content delimited by `|` and quoted by `'`: + +`writeCSV(...?delimiter=%7C"e=%27)` \ No newline at end of file