nealrichardson / httptest

A Test Environment for HTTP Requests in R
https://enpiar.com/r/httptest/
Other
80 stars 10 forks source link

use_httptest() not exported in version 3.1.0 (CRAN's version) #20

Closed ramiromagno closed 6 years ago

ramiromagno commented 6 years ago

hi,

It seems your guidelines on how to use this package are broken for CRAN's version 3.1.0 because the function use_httptest() is not exported.

Works fine though with version 3.1.1. (installed from github):

# Previously installed from CRAN with install.packages("httptest")
library(httptest)
# Loading required package: testthat
packageVersion("httptest")
# [1] ‘3.1.0’
"use_httptest" %in% ls("package:httptest")
# [1] FALSE
# Installing now the dev version from Github
detach("package:httptest", unload=TRUE)
devtools::install_github("nealrichardson/httptest")

# Downloading GitHub repo nealrichardson/httptest@master
# (...)
# * DONE (httptest)
library(httptest)
packageVersion("httptest")
# [1] ‘3.1.1’
"use_httptest" %in% ls("package:httptest")
# [1] TRUE
nealrichardson commented 6 years ago

Correct: the README.md in GitHub reflects what is in GitHub, which has not yet been released to CRAN. https://cran.r-project.org/web/packages/httptest/readme/README.html does not mention use_httptest()

We're due for a CRAN release, which will resolve this. Thanks for bringing it to my attention. In the meantime, README.md does explain what use_httptest() does, so you can add the package manually.

ramiromagno commented 6 years ago

Fair enough.

But if you keep upfront in your Github README.md:

install.packages("httptest")

Then people are going to assume that whatever follows is applicable to your pkg regardless of where it's coming from.

nealrichardson commented 6 years ago

Yes, you are right, and thanks for pointing it out.