Initialise un dépôt de policy brief (PB) OFCE
setup_pb.RdÉquivalent PB de [setup_wp()]. Copie les gabarits embarqués dans le package (`inst/setup_pb/`) à la racine du dépôt, initialise la branche `gh-pages` pour la pré-publication, et adapte le `_quarto.yml` avec les métadonnées du PB (titre, numéro, année, langue, URLs).
Usage
setup_pb(
path = ".",
lang = "fr",
hypothesis = NULL,
versionning = NULL,
stage_target = NULL
)Arguments
- path
Chemin vers la racine du dépôt. Défaut `"."`.
- lang
Chaîne. Langue principale : `"fr"` (défaut) ou `"en"`.
- hypothesis
Logique. Active les commentaires Hypothesis. Défaut `FALSE`.
- versionning
Obsolète et ignoré (avertissement s'il est fourni) : un brouillon est toujours versionné, un PB publié ne l'est plus.
- stage_target
Chaîne. Destination de pré-publication (brouillon, `pb` non encore attribué) : `"auto"` (défaut), `"ftp"` (staging OFCE), `"gh-pages"`. Cf. [setup_wp()] pour la sémantique détaillée.
Details
Précondition bloquante : `path` doit déjà être un dépôt git (`git init`, ou un clone d'un dépôt GitHub existant) — sinon la fonction s'arrête immédiatement avec [cli::cli_abort()]. `_quarto.yml`, lui, n'a pas besoin d'exister au préalable : `setup_pb()` le crée depuis le gabarit du package si absent.
La fonction est **non-destructive** pour les fichiers utilisateur : sur un dépôt existant, les fichiers gabarits `.qmd` et scripts (dont `_quarto.yml`) ne sont pas écrasés, et les champs YAML ne sont mis à jour que si l'argument correspondant a été fourni explicitement. `repo-url`, `favicon` et `ofce_pb: true` sont toujours positionnés. `website.site-url`/`site-path` sont toujours (re)calculés dès que `pb` est non nul.
En revanche, les **workflows GitHub Actions** (`.github/workflows/`) sont **toujours mis à jour** depuis la version de référence du package.
`pb` n'est **pas** un argument : il est soit lu depuis un `_quarto.yml` déjà existant, soit écrasé par une entrée confirmée du registre central (`ofce/wp-registry`, sous-dossier `pb/`), jamais choisi librement par l'appelant. Un dépôt sans `_quarto.yml` et sans entrée de registre reste un brouillon (`pb` absent) ; pour obtenir un numéro, utiliser [pb_registry_request()] puis relancer `setup_pb()` une fois la PR fusionnée. Le champ `annee` n'est pas utilisé pour les PB : chaque série (clé `pb_series` de `_quarto.yml`, `"ofce"` si absente) est numérotée à partir de 1, indépendamment de l'année de publication. Les paramètres de la série (préfixe d'URL, préfixes des PDF, `container-title`) sont lus dans `pb/index.json` du registre central ; si l'index est inaccessible, les champs qui en dépendent ne sont pas recalculés.
**Versions** : seul un brouillon est versionné (clé `version`, URL de staging `staging.ofce.fr/repo/version/`). À la publication (`pb` attribué), la clé `version` est supprimée de `_quarto.yml` et le PB est déployé sans segment de version à `www.ofce.fr/pb/path-prefixpb/` ; une correction ultérieure se fait en redéployant à la même adresse. `nb` (numéro lu par l'extension `pb` pour distinguer brouillon et publié) est écrit à la publication et retiré pour un brouillon.
`author` est destiné à ne vivre que dans `_quarto.yml` : si `index.qmd` en porte une (héritage d'un ancien gabarit, ou ajout manuel), elle est déplacée vers `_quarto.yml` – remplaçant la valeur qui y était déjà, généralement le placeholder du gabarit – puis commentée dans `index.qmd`, avec un avertissement décrivant le déplacement. Un `index.qmd` sans clé `author` ne déclenche aucune modification.
Les extensions Quarto OFCE (`_extensions/`) sont installées/mises à jour via [ofce::setup_quarto()], qui les récupère depuis le dépôt GitHub `OFCE/ofce-quarto-extensions` — la fonction nécessite donc un accès réseau. Juste avant cet appel, `setup_pb()` vérifie aussi (via `check_ofce_version()`) que le package **ofce** installé est en version `>= 1.3.39` — sinon la fonction s'arrête immédiatement avec [cli::cli_abort()].
Côté PDF, `pb-pdf` (LaTeX) et `pb-typst` (Typst) sont les deux moteurs légitimes. Le nom du PDF de brouillon (`pb` non attribué) est `draft-prefix-repo-version.pdf` (ex. `ife-draft-pb-csskvv-chn-v1.pdf`), identique quel que soit le moteur actif — sans segment de version si `version` n'est pas encore renseignée — recalculé à chaque appel. Une fois publié (`pb` connu), les deux moteurs produisent `pdf-prefixpb.pdf` (ex. `IFEPB12.pdf`).