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}
+}