RSiteSearch              package:utils              R Documentation

_S_e_a_r_c_h _f_o_r _K_e_y _W_o_r_d_s _o_r _P_h_r_a_s_e_s _i_n _t_h_e _R-_h_e_l_p _M_a_i_l_i_n_g _L_i_s_t _A_r_c_h_i_v_e_s
_o_r _D_o_c_u_m_e_n_t_a_t_i_o_n

_D_e_s_c_r_i_p_t_i_o_n:

     Search for key words or phrases in the R-help mailing list
     archives, help pages, vignettes or task views, using the search
     engine at <URL: http://search.r-project.org> and view them in a
     web browser.

_U_s_a_g_e:

     RSiteSearch(string,
                 restrict = c("Rhelp08", "functions", "views"),
                 format = c("normal", "short"),
                 sortby = c("score", "date:late", "date:early",
                            "subject", "subject:descending",
                            "from", "from:descending",
                            "size", "size:descending"),
                 matchesPerPage = 20)

_A_r_g_u_m_e_n_t_s:

  string: word(s) or phrase to search.  If the words are to be searched
          as one entity, enclose all words in braces (see example).

restrict: a character vector, typically of length larger than one: What
          areas to search in: 'Rhelp08' for R-help mailing list archive
          from January 2008 'Rhelp02' for mailing list archive
          2002-2007 'Rhelp01' for mailing list archive before 2002
          'R-devel' for R-devel mailing list 'R-sig-mix' for R-devel
          mailing list     'functions' for help pages 'views' for task
          views 'vignettes' for package vignettes Use 'c()' to specify
          more than one.

  format: 'normal' or 'short' (no excerpts); can be abbreviated.

  sortby: character string (can be abbreviated) indicating how to sort
          the search results:
           ('score', 'date:late' for sorting by date with latest
          results first, 'date:early' for earliest first, 'subject' for
          subject in alphabetical order, 'subject:descending' for
          reverse alphabetical order, 'from' or 'from:descending' for
          sender (when applicable), 'size' or 'size:descending' for
          size.)

matchesPerPage: How many items to show per page.

_D_e_t_a_i_l_s:

     This function is designed to work with the search site at <URL:
     http://search.r-project.org>, and depends on that site continuing
     to be made available (thanks to Jonathan Baron and the School of
     Arts and Sciences of the University of Pennsylvania).

     Unique partial matches will work for all arguments.  Each new
     browser window will stay open unless you close it.

_V_a_l_u_e:

     (Invisibly) the complete URL passed to the browser, including the
     query string.

_A_u_t_h_o_r(_s):

     Andy Liaw and Jonathan Baron

_S_e_e _A_l_s_o:

     'help.search', 'help.start' for local searches.

     'browseURL' for how the help file is displayed.

_E_x_a_m_p_l_e_s:

      # need Internet connection
     RSiteSearch("{logistic regression}") # matches exact phrase
     Sys.sleep(5) # allow browser to open, take a quick look
     RSiteSearch("Baron Liaw", restrict = "Rhelp02")
     ## Search in R-devel archive and recent mail (and store the query-string):
     Sys.sleep(5)
     fullquery <- RSiteSearch("S4", restrict = c("R-dev", "Rhelp08"))
     fullquery # a string of ~ 116 characters
     ## the latest purported bug reports, responses ...
     Sys.sleep(5)
     RSiteSearch("bug", restrict = "R-devel", sortby = "date:late")

