diff --git a/Project.toml b/Project.toml index 505cb3d..e072cdd 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "TidierFiles" uuid = "8ae5e7a9-bdd3-4c93-9cc3-9df4d5d947db" authors = ["Daniel Rizk and contributors"] -version = "0.1.0" +version = "0.1.1" [deps] Arrow = "69666777-d1a9-59fb-9406-91d4454c9d45" diff --git a/docs/examples/UserGuide/Arrow.jl b/docs/examples/UserGuide/Arrow.jl index d04dd7e..21d3438 100644 --- a/docs/examples/UserGuide/Arrow.jl +++ b/docs/examples/UserGuide/Arrow.jl @@ -1,10 +1,10 @@ # Arrow file reading and writing is powered by Arrow.jl # ## `read_arrow` -# read_arrow(path; skip=0, n_max=Inf, col_select=nothing) +# `read_arrow(path; skip=0, n_max=Inf, col_select=nothing)` -# This function reads a Parquet (.parquet) file into a DataFrame. The arguments are: +# This function reads an Arrow (.arrow) file into a DataFrame. The arguments are: -# - `path`: The path to the .parquet file. +# - `path`: The path to the .arrow file. # - `skip`: Number of initial rows to skip before reading data. Default is 0. # - `n_max`: Maximum number of rows to read. Default is `Inf` (read all rows). # - `col_select`: Optional vector of symbols or strings to select which columns to load. Default is `nothing` (load all columns). @@ -12,8 +12,8 @@ # ## `write_arrow` # `write_arrow(df, path)` -# This function writes a DataFrame to a Parquet (.parquet) file. The arguments are: +# This function writes a DataFrame to an Arrow (.arrow) file. The arguments are: # - `df`: The DataFrame to be written to a file. -# - `path`: The path where the .parquet file will be created. If a file at this path already exists, it will be overwritten. +# - `path`: The path where the .arrow file will be created. If a file at this path already exists, it will be overwritten. # - Additional arguments for writing arrow files are not outlined here, but should be available through the same interface of `Arrow.write`. Refer to Arrow.jl [documentation](https://arrow.apache.org/julia/stable/manual/#Arrow.write) at their page for further explanation. \ No newline at end of file diff --git a/docs/examples/UserGuide/parquet.jl b/docs/examples/UserGuide/parquet.jl index d636dd6..aab487c 100644 --- a/docs/examples/UserGuide/parquet.jl +++ b/docs/examples/UserGuide/parquet.jl @@ -1,6 +1,6 @@ # Parquet file reading and writing is powered by Parquet2.jl # ## `read_parquet` -# read_parquet(path; col_names=true, skip=0, n_max=Inf, col_select=nothing) +# `read_parquet(path; col_names=true, skip=0, n_max=Inf, col_select=nothing)` # This function reads a Parquet (.parquet) file into a DataFrame. The arguments are: