2016-04-26 10 views
6

Sto usando il pacchetto pkgdown per generare l'elegante e statica pagina manuale per il pacchetto R (chiamata RTCGA). Quando eseguo il codice per produrre la documentazione statica come sito ho utilizzare i seguenti comandipkgdown R pacchetto La funzione build_site fa sì che i pacchetti dipendenti non possano essere caricati

> pkgdown::build_site() 
Initialising site ------------------------------------------------------------------------------------- 
Copying '/home/mkosinski/R/x86_64-pc-linux-gnu-library/3.3/pkgdown/assets/jquery.sticky-kit.min.js' 
Copying '/home/mkosinski/R/x86_64-pc-linux-gnu-library/3.3/pkgdown/assets/link.svg' 
Copying '/home/mkosinski/R/x86_64-pc-linux-gnu-library/3.3/pkgdown/assets/pkgdown.css' 
Copying '/home/mkosinski/R/x86_64-pc-linux-gnu-library/3.3/pkgdown/assets/pkgdown.js' 
Building home ----------------------------------------------------------------------------------------- 
Writing '/home/mkosinski/GitHub/RTCGA/docs/index.html' 
Building function reference --------------------------------------------------------------------------- 
Loading RTCGA 
Welcome to the RTCGA (version: 1.5.1). 
trying URL 'http://gdac.broadinstitute.org/runs/stddata__2015_11_01/data/ACC/20151101/gdac.broadinstitute.org_ACC.Merge_mirnaseq__illuminahiseq_mirnaseq__bcgsc_ca__Level_3__miR_gene_expression__data.Level_3.2015110100.0.0.tar.gz' 
Content type 'unknown' length 309876 bytes (302 KB) 
================================================== 
downloaded 302 KB 

Warning: Topics missing from index: RTCGA-package, theme_RTCGA 
Building articles ------------------------------------------------------------------------------------- 
Building article 'RTCGA_Workflow.html' 
Building article 'Web_Applications.html' 

Questo codice viene valutata nella root del progetto RTCGA pacchetto e fornisce informazioni che RTCGA è stato caricato e la documentazione è stato creato.

Ma ho trovato un bug nella documentazione nella maggior parte delle pagine - c'è un errore dicendo

Error: package ‘RTCGA’ required by ‘RTCGA.rnaseq’ could not be found

enter image description here

Così nessuno di esempi può essere eseguito. Inoltre quando corro library(RTCGA.rnaseq) dopo che ho usato build_site Non posso caricare il pacchetto dipendente RTCGA più

> library(RTCGA) 
> library(RTCGA.rnaseq) 
Error: package ‘RTCGA’ required by ‘RTCGA.rnaseq’ could not be found 

Quando eseguo library(RTCGA.rnaseq) nella nuova sessione senza chiamare i pkgdown::build_site i dipendenti RTCGA carichi di pacchetti normalmente, senza avvertimenti.

Sospetto che ciò sia causato da qualsiasi impostazione eseguita da build_site ma non ho idea di come risolverli e come creare una documentazione statica adeguata con l'utilizzo del pacchetto pkgdown.

Eventuali commenti?

+0

anche cross-postato qui https://github.com/hadley/pkgdown/issues/98 –

risposta

3

Sembra che abbia trovato un brutto lavoro. Il pacchetto software RTCGA utilizza 8 pacchetti di dati nei relativi esempi. Ogni pacchetto di dati richiede il caricamento di RTCGA. pkgdown::build_site() utilizza devtools::load_all() che carica stranamente solo oggetti da RTCGA ma non consente di caricare questo pacchetto durante l'esecuzione di esempi.

Ho rimosso RTCGA dal Depends dei pacchetti di dati modificando quei pacchetti meta-Informations come

packages_to_remove_RTCGA_from_Depends <- 
    c("RTCGA.clinical", 
    "RTCGA.mutations", 
    "RTCGA.rnaseq", 
    "RTCGA.RPPA", 
    "RTCGA.mRNA", 
    "RTCGA.miRNASeq", 
    "RTCGA.methylation", 
    "RTCGA.CNV") 

sapply(packages_to_remove_RTCGA_from_Depends, function(data_package){ 
    Meta <- readRDS(file.path(.libPaths()[1], data_package, "Meta", "package.rds")) 
    Meta$Depends <- list() 
    saveRDS(Meta, file.path(.libPaths()[1], data_package, "Meta", "package.rds")) 
})