Giter Club home page Giter Club logo

utilitr-template's Introduction

Modèle de documents pour le projet utilitR

R build status Exemple output

This package aims to simplify the formatting of utilitR documentation. A series of function to customize rmarkdown output is proposed in this package.

An example website built using this package can be found here

You can use

rmarkdown::draft('index.Rmd', template="utilitr", package="utilitr", edit = FALSE)

or File > new File > R Markdown > FromTemplate > Modèle documentation utilitR (in that case make sure to change the .Rmd filename into index.Rmd) to create a MWE of the output format.

You can either generate a static website or a PDF book using our package:

  • Static website can be generated using bookdown with the following command:
bookdown::render_book("index.Rmd", output_dir = "_public", output_format = "utilitr::html_document")
  • PDF book can be generated using our pdf_document function that uses pagedown package under the hood:
utilitr::pdf_document()

utilitr-template's People

Contributors

oliviermeslin avatar linogaliana avatar rlesur avatar py-b avatar

Stargazers

 avatar Thomas Vroylandt avatar

Watchers

Cédric Couralet avatar James Cloos avatar Olivier Levitt avatar Juliette Fourcot avatar  avatar  avatar

Forkers

ddotta heikeljazi

utilitr-template's Issues

Modifier la couleur des liens hypertexte dans le texte

La couleur des liens hypertexte (#3C5C5C) dans le texte du site bs4 est trop proche du noir, ce qui fait qu'on ne repère pas les liens.

On pourrait ajouter main a[href] {color: à définir;} dans customize-bs4.css, de façon à ne pas modifier les deux barres de navigation (pour lesquelles la couleur existante me semble OK car elles ne sont constitués que de liens hypertexte par définition). Attention, il faut s'assurer que le print ne devient pas trop moche. Normalement ça ne touche pas le pdf pagedown qui utilise d'autres CSS.

Et au fait @RLesur et @linogaliana , revoilà une issue dans le dépôt.

Remanier la méthode pour tester le template

Suite à nos discussions avec Romain, il apparaît que la méthode actuelle pour tester le template utilitR est un peu brouillonne, sur deux points:

  • elle repose sur deux fonctions du package: test_template et pdf_document. Or c'est bizarre d'utiliser des fonctions du package pour le tester lui-même.
  • elle utilise le répertoire de développement du package comme dossier de test => c'est pas très propre.

Il faudrait clarifier la méthode pour tester les modèles de document (donc essentiellement les CSS et les JS), en les séparant des fonctions de compilation. Voici une solution potentielle:

  • mettre dans le package deux scripts qui compilent le site et le pdf sur des codes d'exemples fournis dans le package. Je crois comprendre que ça reviendrait essentiellement à des petits scripts appelant utilitr::pdf_document et utilitr::html_paged avec les Rmd des MWE.
  • il faudrait trouver un moyen pour que les tests ne se fassent pas dans le répertoire de développement du package (dans un dossier temporaire?). On pourrait peut-être écrire une fonction qui déplacerait l'ensemble des fichiers des MWE vers un dossier temporaire?

Génération du pdf en erreur

Les pipelines qui construisent le pdf avec pagedown sont en erreur, par ex https://github.com/InseeFrLab/utilitR/runs/2640274030

Cela provient du fait que le HTML généré est tronqué (il manque la fin du fichier).

Cela semble dû à un bug dans le package rmarkdown lorsqu'on utilise le paramètre copy_resources = TRUE. En effet, si l'on met copy_resources = FALSE ici, la génération du pdf fonctionne :

copy_resources = TRUE,

Changer copy_resources à FALSE nécessite d'utiliser des HTML dependencies pour gérer les CSS.
Deux exemples pour le faire mais il y en a bien d'autres :

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.