Can't build vignettes #44
Comments
|
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? |
|
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. 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. |
|
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) |
|
That is such a simple and great solution. I can just show the api section
but not evaluate it then import the data with an invisible block.
…On Tue, Feb 27, 2018 at 1:43 AM Michael Sumner ***@***.***> wrote:
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.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#44 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AFaR2ZhJ1ReZkS2vnFK_fswlnf8MAv6hks5tY842gaJpZM4SSVtk>
.
|
|
Closed by merge or pull request #46. |
|
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! |
|
Can I reopen this? I want to install the vignettes. Is the workaround to fork the repo and build a |
|
Did the most recent build not work?
…On Wed, May 30, 2018 at 3:21 PM M. Edward (Ed) Borasky < ***@***.***> wrote:
Can I reopen this? I want to install the vignettes. Is the workaround to
fork the repo and build a pkgdown site?
—
You are receiving this because you modified the open/close state.
Reply to this email directly, view it on GitHub
<#44 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AFaR2flOxk5kV4bXJIvuT88mWG-Z_a_lks5t3xt5gaJpZM4SSVtk>
.
|
|
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 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 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. |
|
I think i fixed the issue: moved "gtfs_obj.rda" to the vignettes folder and called it directly.
pushed changes. give them a go.
… On Jun 2, 2018, at 3:03 PM, M. Edward (Ed) Borasky ***@***.***> wrote:
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 <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.
—
You are receiving this because you modified the open/close state.
Reply to this email directly, view it on GitHub <#44 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFaR2aOUUN1afi4Cnu_x3RjW6s1_m8eJks5t4wvKgaJpZM4SSVtk>.
|
|
Yep - installs fine! Thanks!! |
When running
devtools::install_github('ropensci/gtfsr', build_vignettes = TRUE), I get the following error.Quitting from lines 59-64 (gtfsr-vignette.Rmd) Error: processing vignette 'gtfsr-vignette.Rmd' failed with diagnostics: API Key not found. Please set your API key using function 'set_api_key()'. Execution halted Installation failed: Command failed (1)It seems obvious that I need to set my API key, however this error shouldn't popup during installation as the set_api_key function is not active prior to installation as it is part of the package.
After installing the package it's also not really clear how to get the vignettes.
Is there any in dept documentation for this package? It has a lot of potential, but it really lacks some extra info.
The text was updated successfully, but these errors were encountered: