rcommunityCMR/afroProverbs

afroProverbsAfrica est un package R qui rassemble des proverbes africains afin de préserver ce patrimoine culturel et de le rendre accessible à la recherche, à l’éducation et à la science des données. # 📜 afroProverbs – Guide Contributeurs Bienvenue dans le projet **afroProverbs** 🎉 Ce document s’adresse aux **membres de l’équipe qui contribuent** au développement du package. Il explique **ce que nous construisons**, **comment nous organisons nos fichiers**, et **quelles sont les étapes à suivre**. --- ## 🌍 Vision `afroProverbsAfrica` est un package R qui collecte et analyse des **proverbes africains multilingues**. Objectif : **préserver la culture** et fournir des outils simples pour la **recherche, l’éducation, la data science et le NLP**. --- ## 🎯 Objectifs - Collecter des proverbes dans plusieurs pays africains (** Cameroun, Congo, Tchad, Centrafrique, Madagascar, Togo**). - Stocker les proverbes dans des **fichiers JSON par pays** (`data-raw/`). - Fusionner ces fichiers en un seul dataset R (`proverbs_core.rda`). - Développer 3 fonctions principales : - `ap_search()` → rechercher un proverbe. - `ap_themes()` → analyser les thèmes. - `ap_tokens()` → tokeniser le texte. - Livrer une **première version (v0.1.0)** sur GitHub avec au moins **1000 proverbes**. --- ## 📂 Organisation du dépôt ``` afroProverbsAfrica/ ├─ R/ # Fonctions R │ ├─ search.R # ap_search() │ ├─ themes.R # ap_themes() │ ├─ tokens.R # ap_tokens() │ └─ utils.R # utilitaires communs │ ├─ data-raw/ # Données brutes en JSON │ ├─ madagascar.json │ ├─ cameroun.json │ ├─ congo.json │ ├─ tchad.json │ ├─ centrafrique.json │ └─ togo.json │ ├─ data/ # Données consolidées pour R │ └─ proverbs_core.rda │ ├─ tests/ # Tests unitaires │ └─ testthat/ │ ├─ test-search.R │ ├─ test-themes.R │ └─ test-tokens.R │ ├─ vignettes/ # Tutoriels (Quickstart) │ └─ quickstart.Rmd │ ├─ DESCRIPTION # Métadonnées du package ├─ NAMESPACE # Fonctions exportées ├─ LICENSE # MIT └─ README_DEV.md # Ce guide (contributeurs) ``` --- ## 🗂️ Format JSON (obligatoire) Chaque fichier JSON doit avoir la même structure : ```json { "id": "mg1", "language": "mg", "country": "Madagascar", "proverb_original": "Ny valala tsy indro …