Can't build vignettes about gtfsr HOT 11 CLOSED

Could you download the data and installed it in the package as a built-in? Whenever examples use the data set, it could include the commented out code that would be required to get it live.

I.e. analogously for the gtfs_obj example, in data-raw/ would be script to record something like this

url <- "http://data.trilliumtransit.com/gtfs/duke-nc-us/duke-nc-us.zip"
gtfs_obj <- url %>% import_gtfs(quiet=TRUE)
usethis::use_data(gtfs_obj)

from gtfsr.

from gtfsr.

Hmmm, you make a great point. The vignette shouldn't require an outside dependency but at the same time, the purpose of the package, and what is shown in the vignette, depends on having access to the API.

I didn't consider this when I wrote the vignette. You can see a lot of it already just by going to the md file on GitHub, but I'll have to think about a work around. Perhaps I'll have to get an API linked to some phantom email and let the world have access to it.

Any issues installing it without the vignette?

from gtfsr.

Thanks. I had no issues installing it without the vignette, however, I would really like to have more documentation on this package. It's a pity that a lot of functions are a bit unclear, but I'm happy to help if you need to as I'll be using your package for the next few months.
About the vignette, it should be possible to generate it without running the set_api_key function. I can look into it, if you want.

Anyway feel free to close the issue and mark it as solved and drop me an e-mail if you would like some help with this.

from gtfsr.

Closed by merge or pull request #46.

from gtfsr.

closed prematurely. made some more added adjustments to what @mdsumner started. was able to compile from a github_install tarball as shown in readme. give a go!

from gtfsr.

Can I reopen this? I want to install the vignettes. Is the workaround to fork the repo and build a pkgdown site?

from gtfsr.

from gtfsr.

I think I found the problem. I forked the repo and tried the build and got the error. It turns out that the failure is happening at line 75 of https://github.com/ropensci/gtfsr/edit/master/vignettes/gtfsr-vignette.Rmd

load("~/GitHub/gtfsr/data/gtfs_obj.rda")

That's a path that doesn't exist on my machine. When I changed it to a path that did exist, the vignette built, as did a pkgdown::build_site.

I'm not sure where that file lands during the vignette build process, so I don't know how to code a fix. But the workaround is to clone the repo and change that line to point to the right path.

from gtfsr.

from gtfsr.

Yep - installs fine! Thanks!!

from gtfsr.