IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

R Discussion :

Documenter son code (ROxygen,inlinedocs,etc.)


Sujet :

R

Vue hybride

Message précédent Message précédent   Message suivant Message suivant
  1. #1
    Membre à l'essai
    Homme Profil pro
    Inscrit en
    Avril 2011
    Messages
    5
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France

    Informations forums :
    Inscription : Avril 2011
    Messages : 5
    Par défaut Documenter son code (ROxygen,inlinedocs,etc.)
    Bonjour,

    Je souhaitais savoir comment vous documentiez proprement votre code développé sous R.
    Je voudrais générer de la documentation (similaire à la Javadoc). Des outils sont apparemment disponibles tels que ROxygen ou inlinedocs. Lequel me conseillez-vous ?

    (J'ai essayé ROxygen, cela me génère un fichier .Rd, comment faire pour avoir quelque chose de plus lisible (affichage sans les balises)?)

    Merci d'avance à vous.

  2. #2
    Membre Expert
    Avatar de pitipoisson
    Homme Profil pro
    Chercheur
    Inscrit en
    Septembre 2006
    Messages
    1 942
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 46
    Localisation : France, Finistère (Bretagne)

    Informations professionnelles :
    Activité : Chercheur
    Secteur : Agroalimentaire - Agriculture

    Informations forums :
    Inscription : Septembre 2006
    Messages : 1 942
    Par défaut
    Bonjour,

    Si les solutions qui produisent du .Rd te conviennent (mis à part le format de sortie) tu devrais jeter un œil du côté des commandes Rdconv , Rd2pdf,...

    Elles s'utilisent en lançant une nouvelle instance de R avec la commande voulue dans un shell/une invite de commande...

    Aide :
    Html (ou autres fichiers textes) :
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    R CMD Rdconv -t html -o <fichier_sortie>.html <fichier_entrée>.Rd
    Les autres options de format sont txt (.txt) et latex (.tex).

    PDF directement (je suppose qu'il faut une distribution LaTeX installée et dans le $PATH) :
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    R CMD Rd2pdf <fichier_entrée>.Rd
    Les différents outils sont décrits dans l'aide de R :
    Je suis intéressé par ton retour d'expérience...

  3. #3
    Membre à l'essai
    Homme Profil pro
    Inscrit en
    Avril 2011
    Messages
    5
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France

    Informations forums :
    Inscription : Avril 2011
    Messages : 5
    Par défaut
    Merci pour votre réponse, cela me convient.
    En revanche, avec roxygen, je génère un fichier .Rd pour chaque fonction créée. Je n'ai pas de fichier général pour tout le package.
    Je souhaiterais avoir une page html regroupant toutes les fonctions (pour le moment, j'arrive seulement à avoir une page html pour chaque fonction avec R CMD Rdconv -t html -o <fichier_sortie>.html <fichier_entrée>.Rd)

Discussions similaires

  1. Avec quoi documenter son code Delphi ?
    Par pepito62 dans le forum Delphi
    Réponses: 5
    Dernier message: 03/07/2013, 15h33
  2. Documenter son code PHP
    Par xess91 dans le forum Eclipse PHP
    Réponses: 1
    Dernier message: 04/10/2012, 12h02
  3. [Toutes versions] Documenter son code
    Par astroinv dans le forum VBA Access
    Réponses: 2
    Dernier message: 27/07/2012, 16h51

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo