Skip to contents

Returns the package-bundled function catalog generated from the top-level functions.yaml manifest in the duckhts repository.

Usage

rduckhts_functions(category = NULL, kind = NULL)

Arguments

category

Optional function category filter.

kind

Optional function kind filter such as "scalar", "table", or "table_macro".

Value

A data frame describing the extension functions, including the DuckDB function name, kind, category, signature, return type, optional R helper wrapper, short description, and example SQL.

Examples

catalog <- rduckhts_functions()
subset(catalog, category == "Sequence UDFs", select = c("name", "description"))
#>               name
#> 27     seq_revcomp
#> 28   seq_canonical
#> 29   seq_hash_2bit
#> 30 seq_encode_4bit
#> 31 seq_decode_4bit
#> 32  seq_gc_content
#> 33       seq_kmers
#>                                                                                              description
#> 27                       Compute the reverse complement of a DNA sequence using A, C, G, T, and N bases.
#> 28                        Return the lexicographically smaller of a sequence and its reverse complement.
#> 29                                         Encode a short DNA sequence as a 2-bit unsigned integer hash.
#> 30 Encode an IUPAC DNA sequence as a list of 4-bit base codes, preserving ambiguity symbols including N.
#> 31                              Decode a list of 4-bit IUPAC DNA base codes back into a sequence string.
#> 32                                    Compute GC fraction for a DNA sequence as a value between 0 and 1.
#> 33                              Expand a sequence into positional k-mers with optional canonicalization.
subset(rduckhts_functions(kind = "table"), select = c("name", "r_wrapper"))
#>                       name                        r_wrapper
#> 1                 read_bcf                     rduckhts_bcf
#> 2                 read_bam                     rduckhts_bam
#> 3               read_fasta                   rduckhts_fasta
#> 4                 read_bed                     rduckhts_bed
#> 5                fasta_nuc               rduckhts_fasta_nuc
#> 6               read_fastq                   rduckhts_fastq
#> 7  detect_quality_encoding rduckhts_detect_quality_encoding
#> 8                 read_gff                     rduckhts_gff
#> 9                 read_gtf                     rduckhts_gtf
#> 10              read_tabix                   rduckhts_tabix
#> 11             fasta_index             rduckhts_fasta_index
#> 12                   bgzip                   rduckhts_bgzip
#> 13                 bgunzip                 rduckhts_bgunzip
#> 14               bam_index               rduckhts_bam_index
#> 15               bcf_index               rduckhts_bcf_index
#> 16             tabix_index             rduckhts_tabix_index
#> 17         read_hts_header              rduckhts_hts_header
#> 18          read_hts_index               rduckhts_hts_index
#> 19          bcftools_score                   rduckhts_score
#> 20               seq_kmers