charlesjb / anno

anno

R package to download and clean references and prepare annotations

anno's Issues

Tests unitaires

• https://github.com/ArnaudDroitLab/DemoPaquetR/blob/master/paquets_R.md

Mettre à jour la man page

• Mettre à jour le manuel de la fonction prepare_anno pour tenir compte des derniers changement
• devtools::document()
• version bump

Générer un fichier de métadonnées

Le fichier de métadonnées doit contenir tous les paramètres de création de la BD:

• préfix
• url
• date de téléchargement
• md5

Téléchargement des GTF

Ajouter une option pour le téléchargement des GTF.

Trouver le bon lien pour chaque organismes sur: http://useast.ensembl.org/info/data/ftp/index.html/

Télécharger le fichier avec le bon nom, voir par exemple: https://github.com/CharlesJB/anno/blob/master/R/prepare_anno.R#L115-L116

Problème de doublons dans les clean names pour Homo sapiens Gencode 42

• Ajouter une commande spécifique pour clean names de gencode sans perdre l'information du _PAR_Y

Badge codecov

Ajouter un badge dans le README pour le codecov

Tolérer variabilité dans les paramètres

I.e.: Homo sapiens, homo sapiens, human, hs, humain...

Appeler une seule fois extract_anno

La fonction extract_anno est appelée trois fois:

• https://github.com/CharlesJB/anno/blob/master/R/prepare_anno.R#L119
• https://github.com/CharlesJB/anno/blob/master/R/prepare_anno.R#L123
• https://github.com/CharlesJB/anno/blob/master/R/prepare_anno.R#L159

Déjà, à la ligne 119 et 123, la fonction extract_anno est appelée sur exactement les mêmes données. On ne devrait pas appeler cette fonction sur les données nettoyées car la seule différence avec les données brutes est au niveau des nom (le identifiants ensembl devraient être identiques).

De plus, étant donnée que l'opération de mapIds est relativement longue, on devrait éviter de la répéter plusieurs fois. On devrait plutôt faire comme aux lignes 174 à 176 où on fait un sous-ensemble des données originales.

TODO:

• Remplacer les fonction extract_anno qui ne sont pas sur les données brutes soit par un filtre (i.e.: la fonction dplyr::filter) ou bien en utilisant un indice comme pour les lignes 174 à 176.
• Ajouter une validation dans la fonction save_anno_resuts pour s'assurer que les identifiants sont identiques pour le fasta et pour l'annotation (on doit retrouver exactement les mêmes identifiants, exactement dans le même ordre).
• Incrémenter la version du paquet dans le fichier DESCRIPTION.

Mettre anno sur gitlab

Tester si anno peut être installé depuis gitlab -- et si oui le faire aussi pour le package rnaseq

R CMD check & R CMD BiocCheck

Review stopifnot

Regarder s'il y a des erreurs stopifnot qui ne sont pas clairs et remplacer par stop au besoin.

Modifier les fichiers générés

• Base de données brute
  • ensembl104_raw_ref.fa
  • ensembl104_raw_ref.csv
• Filtrage sans chromosomes alternatifs
  • ensembl104_no_alt_chr.fa
  • ensembl104_no_alt_chr.csv
• Filtrage avec uniquement les protein coding
  • ensembl104_protein_coding.fa
  • ensembl104_protein_coding.csv

Ajouter un README ou une vignette

Nouvelle version Rattus norvegicus

Le code ne fonctionne plus avec Rattus norvegicus car il y a une nouvelle version.

Dans le code présentement, il utilise Rnor_6.0: https://github.com/CharlesJB/anno/blob/master/R/prepare_anno.R#L251

Sur Ensembl, c'est maintenant mRatBN7.2: http://ftp.ensembl.org/pub/release-108/fasta/rattus_norvegicus/cdna/

Il faut:

• Trouver la release à partir de laquelle le changement a eu lieu
• Modifier le code de manière similaire à ce qu'on avait fait précédemment pour Mus musculus (https://github.com/CharlesJB/anno/blob/master/R/prepare_anno.R#L230-L244)
• Ne pas oublier de mettre à jour la version dans le fichier DESCRIPTION

Paramètre par défaut pour org: Ensembl

Il faudrait donner au paramètre org la valeur par défaut "Ensembl".

• Ajouter une valeur par défaut
• Mettre à jour la man page
• devtools::document()
• Incrémenter la version du paquet

Valider duplicat

Une fois le nettoyage des identifiants complété (i.e.: retirer le # de version), valider qu'il n'y a pas de duplicat.

On enlève le numéro de version ici: https://github.com/CharlesJB/anno/blob/master/R/prepare_anno.R#L124

Il faut donc valider qu'il n'y a pas de duplicat avant de sauvegarder ici: https://github.com/CharlesJB/anno/blob/master/R/prepare_anno.R#L131

Télécharger release la plus récente par défaut

Ajouter une valeur NA à utiliser par défaut pour le paramètre release dont le comportement sera d'aller chercher la release la plus récente de l'annotation.

• Pour Ensembl et Gencode

Séquences de taille 0?

Selon la ligne 162, il y a des séquences de taille 0 qu'il faut ignorer. À priori, il me semble qu'il ne devrait pas y avoir de séquences de taille 0 dans la base de données de référence. Il faudrait donc remplacer par un stopifnot ou bien par une commande équivalente.

Si jamais il y a vraiment des séquences de taille 0 dans les bases de données, il faudrait documenter le phénomène avant avant de conserver le code tel qu'il est présentement.

Ajouter un paramètre path

Pour le moment les sorties sont sauvegardées dans le répertoire courant, a terme il peut être intéressant de créer un argument path permettant de sauvegarder les sorties dans un dossier au choix. le défaut de ce path restera ".", le dossier courant.

A faire :

• Ajouter un argument path, defaut "."
• Ajouter ce path au prefix lors de la sauvegarde des fichiers
• Tester l'ajout du path
• Mettre à jour le manuel de la fonction