how to log unapproved package and function use

[nicholas-masel]

I created a basic vignette to explain how to use timber to log the unapproved use along with a simple example. I'm happy for this to go somewhere other than a vignette too. Regardless, the content is here though and ready for review.

There is one function embedded in the vignette that we might want to export. @kodesiba You mentioned maybe storing in some sort of utils. Check out the vignette for more context for .x and .y arguments.

build_approved <- function(.x, .y){
   
  all <- tibble::tibble(function_name = getNamespaceExports(.x),
                        library = paste0("package:", .x))

  if (.y[1] %in% c("All", "all")){
    all
  } else{
    all[all$function_name %in% .y,]
  }
  
}

I also don't want this to hold up anything, so if this isn't key, we can save for later.

[nicholas-masel]

Ok, so everything failed :(

I'm using getNamespaceExports() to get all of the functions for a package, which requires the package to be installed.

In the example, I think I can just swap out the use of haven to some other package we import and hopefully that will work.

[nicholas-masel]

I'm stumped as to why axecute is failing in ubuntu dev.

Here is the error:

Error: --- re-building ‘approved.Rmd’ using rmarkdown
Quitting from lines 100-101 (approved.Rmd) 
Error: Error: processing vignette 'approved.Rmd' failed with diagnostics:
'length = 3' in coercion to 'logical(1)'
--- failed re-building ‘approved.Rmd’
--- re-building ‘timber.Rmd’ using rmarkdown
--- finished re-building ‘timber.Rmd’

Here is line 100-101:

axecute(file.path(dir,"mpg.R"))

[kodesiba]

@nicholas-masel if you pull down dev into your branch you will get the update. It was the sessioninfo issue that I just merged into dev

[nicholas-masel]

@nicholas-masel if you pull down dev into your branch you will get the update. It was the sessioninfo issue that I just merged into dev

Thanks @kodesiba! That did the trick.

[kodesiba]

@nicholas-masel I really like how you used the different chunks in the vignette to show the user what they need to see and also make everything work. I showed this to @thomasp-b when he and I talked about the table vignette and this is a great strategy for making vignettes for {timber} in a way that is super informative and also intuitive to the user. While I think the whole log is fine for this one we can always use the internal writers and such to write out abbreviated logs to highlight specific pieces should we want to do that

[nicholas-masel]

@kodesiba thanks for the feedback! That's a great idea to just use the writer to highlight sections. I'm open to swapping this in as the one section is the highlight here. Let discuss in the next call and then I can finalize and merge if it's OK with @bms63 and @thomasp-b.

[thomasp-b]

Great PR. No more comments from me except that I heavily used your vignette to create mine.