Man pages for ursa-labs/arrowbench
Tools for Continuous and Interactive Benchmarking
| all_sources | Known data files |
| array_altrep_materialization | Benchmark for materializing an altrep Arrow array |
| array_to_vector | Benchmark for reading an Arrow array to a vector |
| as.data.frame.BenchmarkResults | Convert benchmark result object to a tidy data frame |
| assemble_metadata | Assemble metadata for a benchmark run |
| BenchEnvironment | Create a test environment to run benchmarks in |
| Benchmark | Define a Benchmark |
| BenchmarkDataFrame | A classed dataframe of benchmarks for running |
| confirm_mem_alloc | Confirm that the memory allocator enabled |
| data_file | Find a data file |
| dataset_taxi_2013 | Benchmark Taxi 2013 dataset reading |
| dataset_taxi_parquet | Benchmark Taxi dataset (Parquet) reading |
| df_to_table | Benchmark for reading a data.frame into an Arrow table |
| ensure_dataset | Make sure a multi-file dataset exists |
| ensure_format | Ensure that a source has a specific format |
| ensure_source | Make sure a data file exists |
| file_with_ext | Get a file with an extension |
| generate_tpch | Generate tpch data |
| get_csv_reader | Get a CSV reader |
| get_csv_writer | Get a CSV writer |
| get_dataset_attr | Get dataset attributes |
| get_default_parameters | Generate a dataframe of default parameters for a benchmark |
| get_input_func | Get an input function for a table |
| get_json_reader | Get a JSON reader |
| get_package_benchmarks | Get a list of benchmarks in a package |
| get_params_summary | Extract the parameter summary as a data.frame |
| get_query_func | Get a query function that will run a specific TPC-H query |
| get_read_function | Get a reader |
| get_source_attr | Get source attributes |
| get_sql_query_func | Get a SQL query |
| get_write_function | Get a writer |
| install_benchconnect | Install benchconnect |
| install_datalogistik | Install datalogistik |
| install_pipx | Install pipx |
| knowns | Known formats and compressions |
| known_sources | Known data files |
| measure | Measure times and memory usage |
| null-default | Default value for NULL |
| placebo | Placebo benchmark for testing |
| R6Point1Class | Version of R6 with heritable static/class methods and... |
| read_csv | Benchmark CSV reading |
| read_file | Benchmark file reading |
| read_json | Benchmark JSON reading |
| read_source | Read a known source |
| remote_dataset | Remote (S3) dataset reading |
| row_group_size | Benchmark effect of parquet row group size |
| run | Run an object |
| run_benchmark | Run a Benchmark across a range of parameters |
| run_bm | Execute a benchmark run |
| run_one | Run a Benchmark with a single set of parameters |
| sync_and_drop_caches | Attempt to drop disk caches |
| tables_refed | For extracting table names from TPC-H queries |
| table_to_df | Benchmark for reading an Arrow table to a data.frame |
| tpc_h | Benchmark TPC-H queries |
| tpch_answer | Get a TPC-H answer |
| tpc_h_queries | all queries take an input_func which is a function that will... |
| tpch_tables | Table names for TPC-H benchmarks |
| validate_format | Validate format and compression combinations |
| write_csv | Benchmark CSV writing |
| write_file | Benchmark file writing |
