Styjun

I'm currently trying to develop my first R package and run into a following problem.

I have a DESCRIPTION file where all needed packages are listed under Imports like suggested by Hadley Wickham in his book. I'm using @importFrom dplyr select to load a function, for internal use.

By running devtools::document() I get an error:

Error in select(paths_original, household_id = H_ID, person_id = P_ID, :
could not find function "select"

Would be great, if someone could help me to understand my mistake.

Thanks in advance!

EDIT:

DESCRIPTION

Package: first_package
Title: first package
Version: 0.0.0.9000
Description: first package
Depends:
 R (>= 3.5.2)
Imports:
 foreign (>= 0.8.71),
 plyr (>= 1.8.4),
 dplyr (>= 0.7.7),
 leaflet (>= 2.0.2),
 sf (>= 0.7.1),
 rgeos (>= 0.4.2),
 geosphere (>= 1.5.7),
 sp (>= 1.3.1),
 rgdal (>= 1.3.6),
 mapview (>= 2.6.0),
 lwgeom (>= 0.1.6),
 roxygen2
License: BSD 2-Clause + file LICENSE
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.0

function:

get_clear_df_paths <- function(paths_original) 
 clean_paths <- select(paths_original,
 household_id = H_ID,
 person_id = P_ID,
 household_person_id = HP_ID,
 weekday = ST_WOTAG,
 month = ST_MONAT,
 holiday = feiertag,
 season = saison,
 regular_job_related_path = W_RBW,
 path_purpose = W_ZWECK,
 starting_point = W_SO2,
 start_time_hour = W_SZS,
 start_time_min = W_SZM,
 arrival_next_day = W_FOLGETAG,
 arrival_time_hour = W_AZS,
 arrival_time_min = W_AZM,
 path_length = wegkm,
 path_length_imp = wegkm_imp,
 path_duration_min = wegmin,
 path_duration_min_imp = wegmin_imp,
 main_vehicle = hvm,
 car_driver = pkw_fmf,
 vehicle_car = W_VM_G,
 vehicle_carsharing = W_VM_H,
 district = stt_mun)

imports.R

#' @importFrom plyr revalue
#' @importFrom dplyr select
#' @importFrom foreign read.spss
NULL

NAMESPACE

# Generated by roxygen2: do not edit by hand

importFrom(dplyr,select)
importFrom(foreign,read.spss)
importFrom(plyr,revalue)

public gist link with relevant code snippets:

https://gist.github.com/bgrt/b7d32cb3aa0bb128f276bad86c89bdd4

I hate to add this because it is "Not an answer," and will update it to include an answer soon or remove it. However, I believe it may be helpful to demonstrate that OP's basic approach should work, so I created a minimal example package importing the apparent problem function.

First I set up the package structure:

library(devtools)
create_package("funImport", rstudio = FALSE)
use_package("dplyr")
use_gpl3_license("X")

I then added one file to R/ containing the following:

#' Select wrapper
#' 
#' @param .data A tbl
#' @param ... Variable names to select
#' 
#' @return The selected variables
#' @export
Select <- function(.data, ...) 
 return(select(.data, ...))


#' @importFrom dplyr select
NULL

I was then able to document(), install() and check() no problem:

document()
# Updating funImport documentation
# Updating roxygen version in /home/jb/funImport/DESCRIPTION
# Writing NAMESPACE
# Loading funImport
# Writing NAMESPACE
# Writing Select.Rd
install()
# Output omitted
check()
# Some output omitted
# ── R CMD check results ─────────────────────────────── funImport 0.0.0.9000 ────
# Duration: 48.2s
# 
# 0 errors ✔ | 0 warnings ✔ | 0 notes ✔

I was also able to use the function no problem:

library(funImport)
tbl <- tibble::tibble(x = 1:10, y = letters[1:10])
tbl
# # A tibble: 10 x 2
# x y 
# <int> <chr>
# 1 1 a 
# 2 2 b 
# 3 3 c 
# 4 4 d 
# 5 5 e 
# 6 6 f 
# 7 7 g 
# 8 8 h 
# 9 9 i 
# 10 10 j 
Select(tbl, x)
# # A tibble: 10 x 1
# x
# <int>
# 1 1
# 2 2
# 3 3
# 4 4
# 5 5
# 6 6
# 7 7
# 8 8
# 9 9
# 10 10

Created a dummy package to test and this works. You need to have your functions documented as shown below. Also, please have a way fo providing global binding for some variables in your functions.

 #' Some paths
 #' @description some paths
 #' @param paths_original Some path
 #' @importFrom dplyr select
 #' @export 
 get_clear_df_paths <- function(paths_original) 
 clean_paths <- select(paths_original,
 household_id = H_ID,
 person_id = P_ID,
 household_person_id = HP_ID,
 weekday = ST_WOTAG,
 month = ST_MONAT,
 holiday = feiertag,
 season = saison,
 regular_job_related_path = W_RBW,
 path_purpose = W_ZWECK,
 starting_point = W_SO2,
 start_time_hour = W_SZS,
 start_time_min = W_SZM,
 arrival_next_day = W_FOLGETAG,
 arrival_time_hour = W_AZS,
 arrival_time_min = W_AZM,
 path_length = wegkm,
 path_length_imp = wegkm_imp,
 path_duration_min = wegmin,
 path_duration_min_imp = wegmin_imp,
 main_vehicle = hvm,
 car_driver = pkw_fmf,
 vehicle_car = W_VM_G,
 vehicle_carsharing = W_VM_H,
 district = stt_mun)
 

Steps:

library(devtools)
library(roxygen2)
create("SODummypkg")
document("SODummypkg")
check("SODummypkg")

Outcome: Ignore the warning(for purposes of this answer). At least the error doesn't show up.

-- R CMD check results ---------------------------------------------- SODummypkg 0.0.0.9000 ----
Duration: 1m 10.7s

> checking DESCRIPTION meta-information ... WARNING
 Dependence on R version '3.5.3' not with patchlevel 0

0 errors √ | 1 warning x | 0 notes √