lockedata / starters

R Package 📦 for initializing projects for various R activities :nut_and_bolt:
https://itsalocke.com/starters/
GNU General Public License v3.0
124 stars 16 forks source link

Training: Add production scripts #4

Open stephlocke opened 7 years ago

stephlocke commented 7 years ago

For the skeleton docs (#1), have a script that produces them and sends to gh-pages branch or docs/

This could then be added to .travis.yml

stephlocke commented 7 years ago

I'm thinking of trying to integrate this into the training projects - or adding a presentation package https://github.com/lockedata/pres-stub (blog post scheduled on how this works)

What do you think @jonmcalder

jonmcalder commented 7 years ago

Looks cool to me - maybe I should wait to see the blog post, but for now I'm wondering how best to approach this given that some of the process/code infrastructure could or should be shared between this and #5?

I think modularity/extensibility is key in all of these building blocks for pRojects, given that the future plan is to come up with neat system for creating and maintaining personal templates for many of the pRoject parameters/settings etc as indicated in #14

In the case of this piece of functionality that would mean template values (including package dependencies where necessary) for things like the theme in _output.yml in addition to sourcing the applicable AUTHORNAME & AUTHOREMAIL params and allowing for override of the sample template etc.

Not sure if this feedback helps in any way?

maelle commented 6 years ago

cf https://github.com/ropenscilabs/tic -- pRojects could use it and https://github.com/ropenscilabs/travis

And https://github.com/lockedata/presdown

stephlocke commented 6 years ago

happy to use other packages that can help us get stuff CI/CDing easily, tho it needs to support non-web outputs fwiw

maelle commented 6 years ago

@stephlocke do you have an example of a repo whose setup you like?

I'm thinking of "simply" writing tic.R templates and using travis::use_tic().

maelle commented 5 years ago

Currently trying the setup with a PDF output. First time did not go well, trying now with an explicit install of texlive in the config file. That part is not supported by starters itself.

maelle commented 5 years ago

PDF output works if one adds this time-consuming line in before_install:


- sudo apt-get -qq update && sudo apt-get install -y --no-install-recommends texlive-full

at the moment I'm thinking this tweak should be documented in a vignette.

maelle commented 5 years ago

Here's the PDF https://maelle.github.io/lockedata.starters9/try.pdf

stephlocke commented 5 years ago

didn't yihui make a tinytex or something 🤔 might be able to help keep the times down

maelle commented 5 years ago

yes but as far as I know if you install tinytex you need to install LaTeX packages by hand?

stephlocke commented 5 years ago

I think the packages might autodeploy but regardless, it should be enough to compile the basics - if folks find they need full LaTeX then they can alter the process