R パッケージ内の関数とタイトルの表を作成する方法

Rにおいて、指定したパッケージに含まれる関数とそのタイトルの一覧をデータフレームとして作成する方法をお伝えします。

環境

Rの動作環境は次になります。

R --version

R version 4.1.3 (2022-03-10) -- "One Push-Up"
Copyright (C) 2022 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

今回、使用するRのパッケージのバージョンは次になります。

packageVersion("tidyverse")
(out)[1] ‘1.3.1’
(out)
packageVersion("devtoolbox")
(out)[1] ‘0.1.0’

一覧表の作成

一覧表を作成するコードは次になります。
ここでは、例として「dplyr」パッケージに含まれる関数とそのタイトルをデータフレームとして作成してみます。

library(tidyverse)
library(devtoolbox)

package_name <-"dplyr"

df <- data.frame(function_name = ls(paste("package", package_name, sep = ":"))) %>%
  rowwise() %>%
  mutate(title = extract_title(function_name, package_name))

変数dfは、次のようになっております。

print(df)
# A tibble: 291 × 2
# Rowwise: 
   function_name title                                                  
                                                              
 1 %>%           Objects exported from other packages                   
 2 across        Apply a function (or functions) across multiple columns
 3 add_count     Count observations by group                            
 4 add_count_    Deprecated SE versions of main verbs.                  
 5 add_row       Objects exported from other packages                   
 6 add_rownames  Convert row names to an explicit variable.             
 7 add_tally     Count observations by group                            
 8 add_tally_    Deprecated SE versions of main verbs.                  
 9 all_equal     Flexible equality comparison for data frames           
10 all_of        Objects exported from other packages                   
# … with 281 more rows