Skip to contents

Tout ce qui sert à générer les pages HTML du site web de l’OFCE se trouve ici.

Installation

Pour installer ofceweb, utiliser pak ou renv::install()

pak::pak("ofceweb/ofceweb")
# ou
devtools::install_github("ofceweb/ofceweb")
# ou 
renv::install("ofceweb/ofceweb")

Le package couvre les usages de plusieurs types d’utilisateurs.

Publier un document de travail en phase staging ou publication

Ces éléments sont détaillés dans la vignette Faire un document de travail.

Le principe est d’avoir le document de travail dans un repo github, sur son compte personnel dans un premier temps puis dans l’organisation OFCE poru sa publication.

Le format du repo est assez libre, un template est proposé, avec quelques éléments obligatoires pour la publication. Le template est implémenté par setup_wp(), fonction non destructive qui préserve ce qui est déjà mis en place (yaml, fichiers). check() diagnostique l’installation et pointe vers les problèmes non bloquants ou bloquants. setup_wp() peut être exécuté autant de fois que l’on veut.

Le document de travail a deux états possibles. Il est d’abord en “brouillon” et est publié en mode staging, c’est-à-dire un mode privé et préliminaire. Il est ensuite validé techniquement et scientifiquement et devient publié. Le rendu du document passe par render() et la publication par publish(). Le bouton render ne produira pas le même résultat. En revanche un menu est ajouté dans les Addinsde Rstudio.

Tant que le document de travail est en phase staging, il est servi par github.com (gh-pages) ou sur le site staging.ofce.fr. Il est possible (très recommandé) de le crypter afin d’en limiter l’accès à un public choisi. La validation attribue un numéro au document de travail et une url stable (qui ne change pas). la fonction publish() assure dans tous les cas la mise en ligne (staging ou stable)

Pour être stagé ou publié sur le site de l’OFCE, la propriété du repo du document de travail doit être transférée à l’organisation OFCE sur github.com (sans danger, vous gardez l’accès complet), avec un renommage du dépôt selon la convention pb-{initiale de l'auteur}-{nom court}, le tout en MINUSCULES. Par exemple : wp-xt-travail.

Le document de travail peut être versionné quand il est hébergé sur staging.ofce.fr ou www.ofce.fr/wp. Les différentes versions peuvent être conservées, une url stable est toujours disponible (www.ofce.fr/wp/{YYYY}/{NNN}) pour le document de travail de l’OFCE n°YYYY-NNN ou (staging.ofce.fr/{repo}/. L’url stable pointe vers la dernière version poussée sur le site.

Une fois le document de travail validé, les auteurs peuvent modifier le document de travail librement. En cas d’abus, cet accès peut être retiré.

Publier un policy brief en phase staging ou publication

Ces éléments sont détaillés dans la vignette vignette("policy-briefs").

Le principe est le même que pour un document de travail : le policy brief vit dans un repo github, sur son compte personnel ou dans l’organisation OFCE. Le template est implémenté par setup_pb(), fonction non destructive équivalente à setup_wp(), qui peut être exécutée autant de fois que l’on veut. check() diagnostique l’installation.

Tant que le policy brief est en phase staging, il est servi par github.com (gh-pages) ou sur le site staging.ofce.fr, avec la même possibilité de cryptage que pour un document de travail. render() et publish() assurent le rendu et la publication.

La publication passe par une validation par un administrateur, avec la même logique que les documents de travail. La différence : les policy briefs ont une numérotation séquentielle depuis l’origine et indépendante de l’année — contrairement aux documents de travail, numérotés par année.

Pour être stagé ou publié sur le site de l’OFCE, la propriété du repo policy brief doit être transférée à l’organisation OFCE sur github.com (sans danger, vous gardez l’accès complet), avec un renommage du dépôt selon la convention pb-{initiale de l'auteur}-{nom court}, le tout en MINUSCULES. Par exemple : pb-xt-relance.

Comme le document de travail, le policy brief peut être versionné une fois hébergé sur staging.ofce.fr ou www.ofce.fr/pb. Une url stable est toujours disponible (www.ofce.fr/pb/{NNN}) pour le policy brief de l’OFCE n°NNN, et pointe vers la dernière version poussée sur le site.

Publier un mini-site en phase staging ou publication

Un mini-site ressemble beaucoup à un document de travail, à ceci près que le format est plus libre et que le mini-site n’est pas nécessairement publié. A priori, les mini-sites publiés doivent être référencés dans le site général. Merci de contacter les administrateurs dans ce cas.

Le mini-site est mis en place par setup_site() (attention, peut être cette fonction est destructive, pensez à commiter avant de l’employer). Il est possiblement crypté (ofceweb::encrypt_site()). Le cryptage est enlevé par remove_encrypt(). Pour le cryptage, il faut définir un mot de passe qui ne doit pas être en clair dans le repo. Pensez à utiliser usethis::edit_r_environ() pour définir une variable contenant le mot de passe ou assurez vous que le mot de passe est dans un fichier dans .gitignore.

Le mini-site peut être publié sur gh-pages comme sur le site de l’OFCE. Notez que le site ne sera référencé s’il n’est pas publié.

La mise à jour du mini-site se fait en le republiant.

Publier la prévision en phase staging ou publication

La prévision est un mini-site particulier. Une version staging (commentaires ouverts, cryptée, non référencée) co existe avec une verison publish (commentaires fermés, url définie (www.ofce.fr/prev/prevYYMM), non cryptée, référencée, suivi statitistique).

Les principales fonctions sont setup_prev(), render() et publish(). Les fonctions helpers seront ajoutées progressivement.

Administrer les principales pages du site web de l’OFCE

Le blog

webblog est le repo du blog de l’OFCE. Pour le modifier vous devez avoir les droits.

Pour générer le blog : aller dans le repo webblog, lancer render_blog() ; avec l’option site2branch=TRUE, le rendu est uploadé sur github dans la branche site-deploy et envoyé sur le site de l’OFCE ; site2branch() fait la même opération. La fonction est documentée pour les options avancées.

Pas de cryptage disponible.

Une github action génère le blog une fois par jour en mode force_freeze=FALSE ce qui met à jour les posts périodiques (freeze: false dans le yaml).

Le blog relecture sera prochainement inclu dans la procédure.

La home page

webhome est le repo de la home page ;

Pour générer la home page, aller dans le repo webhome, lancer render() (qui détecte le type home via ofce_home: true dans _quarto.yml) ; avec l’option site2branch=TRUE, le rendu est uploadé sur github dans la branche site-deploy et envoyé sur le site de l’OFCE ; deploy()/site2branch() font la même opération. Utiliser publish() pour enchaîner rendu et déploiement en une seule commande.

les statistiques de fréquention et de production

webstat est le repo du dashboard des statistiques de fréquentation (crytpé) ;

Pour générer le dashboard de fréquentation webstat : aller dans le repo webstat, et pusher sur main, le site est généré à partir de cet évènement ; 2 fois par jour webstat est actualisé.

Le nowcast

Le nowcast a sa page.