getBiocSubViews          package:biocViews          R Documentation

_B_u_i_l_d _a _l_i_s_t _o_f _B_i_o_c_V_i_e_w _o_b_j_e_c_t_s _f_r_o_m _a _p_a_c_k_a_g_e _r_e_p_o_s_i_t_o_r_y

_D_e_s_c_r_i_p_t_i_o_n:

     This function returns a list of 'BiocView-class' objects
     corresponding to the subgraph of the views DAG induced by
     'topTerm'.  In short, this does the same thing as 'getBiocViews',
     but limits the vocabulary to 'topTerm' and all of its decendents.

_U_s_a_g_e:

     getBiocSubViews(reposUrl, vocab, topTerm, local = FALSE)

_A_r_g_u_m_e_n_t_s:

reposUrl: URL for a CRAN-style repository that hosts a 'VIEWS' file at
          the top-level.

   vocab: A 'graph-class' object representing the ontologyof views. 
          This graph should be a directed acyclic graph (DAG).

 topTerm: A string giving the name of the subview DAG.  This view and
          all of its decendents will be included in the result.

   local: logical indicating whether to assume a local package
          repository.  The default is 'FALSE' in which case absolute
          links to package detail pages are created.

_D_e_t_a_i_l_s:

     The root of the vocabulary DAG is implicitly included in the view
     creation process order to build views with a link back to the top.
      It is removed from the return list.

     This function is tailored to generation of Bioconductor Task
     Views. With the current vocabulary, it probably only makes sense
     to call it with 'topView' set to one of '"Software"',
     '"AnnotationData"', or '"ExperimentData"'.  This is a hack to
     allow the biocViews code to manage HTML views across more than one
     repository.

_V_a_l_u_e:

     A list of 'BiocView-class' objects.  The names of the list give
     the name of the corresponding view.

_A_u_t_h_o_r(_s):

     Seth Falcon

_S_e_e _A_l_s_o:

     'write_VIEWS', 'writeBiocViews'

_E_x_a_m_p_l_e_s:

     data(biocViewsVocab)
     reposPath <- system.file("doc", package="biocViews")
     reposUrl <- paste("file://", reposPath, sep="")
     biocViews <- getBiocSubViews(reposUrl, biocViewsVocab, "Software")
     print(biocViews[1:2])

