summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/codec_is_available.Rd
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
commite6918187568dbd01842d8d1d2c808ce16a894239 (patch)
tree64f88b554b444a49f656b6c656111a145cbbaa28 /src/arrow/r/man/codec_is_available.Rd
parentInitial commit. (diff)
downloadceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz
ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/arrow/r/man/codec_is_available.Rd')
-rw-r--r--src/arrow/r/man/codec_is_available.Rd25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/arrow/r/man/codec_is_available.Rd b/src/arrow/r/man/codec_is_available.Rd
new file mode 100644
index 000000000..b3238ff1d
--- /dev/null
+++ b/src/arrow/r/man/codec_is_available.Rd
@@ -0,0 +1,25 @@
+% 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{
+\dontshow{if (arrow_available()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
+codec_is_available("gzip")
+\dontshow{\}) # examplesIf}
+}