File: codec_is_available.Rd

package info (click to toggle)
apache-arrow 23.0.1-1
  • links: PTS
  • area: main
  • in suites: sid
  • size: 76,220 kB
  • sloc: cpp: 654,608; python: 70,522; ruby: 45,964; ansic: 18,742; sh: 7,365; makefile: 669; javascript: 125; xml: 41
file content (23 lines) | stat: -rw-r--r-- 626 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/compression.R
\name{codec_is_available}
\alias{codec_is_available}
\title{Check whether a compression codec is available}
\usage{
codec_is_available(type)
}
\arguments{
\item{type}{A string, one of "uncompressed", "snappy", "gzip", "brotli",
"zstd", "lz4", "lzo", or "bz2", case-insensitive.}
}
\value{
Logical: is \code{type} available?
}
\description{
Support for compression libraries depends on the build-time settings of
the Arrow C++ library. This function lets you know which are available for
use.
}
\examples{
codec_is_available("gzip")
}