Skip to main content

notebooks - How to get complete Documentation Center graph of guide pages?


On the very last image below you can see a typical path of walking through Documentation Center guide pages. What is the best way to get the graph data and visualize the whole structure of these connections starting from the main table of contents page? An obvious thing to do is to look for example into directory:


SetDirectory["C:\\Program Files\\Wolfram\\Research
              \\Mathematica\\8.0\\Documentation\\English\\System\\Guides"]


FileNames[] // Column

enter image description here


But I am not sure what is the next most efficient way to analyze the connections.


A walk through guide pages


enter image description here


------------ UPDATE: new built-in WolframLanguageData ------------


I posted an answer in connection with newly released functionality - WL now contains data about itself.


------------ UPDATE: image from @Leoind data ------------



style = {VertexStyle -> White, VertexShapeFunction -> "Point", 
  EdgeStyle -> Directive[Opacity[.3], Hue[.15, .5, .8]], 
  Background -> Black, EdgeShapeFunction -> (Line[#1] &), 
  ImageSize -> 500};

gr = Graph[Union[Sort /@ data], style]

enter image description here


The origin of self-loops was explained by @R.M in his comment. Almost all guide pages have their own URL at the top navigation bar. Here is the final graph with removed self-loops:


am = AdjacencyMatrix[gr];(am[[#, #]] = 0) & /@ Range[Length[am]];

AdjacencyGraph[am, style]

enter image description here



Answer



I will answer the technical part of the question - namely, how to get the entire graph. How one would go about analyzing and visualizing it, is another story.


This will open and parse a given guide notebook, and get the links to other notebooks:


ClearAll[getLinks];
getLinks[file_] :=
  With[{nb = NotebookOpen[file]},
    With[{result = 

        Cases[NotebookGet[nb], (ButtonData -> ref_) :> ref, Infinity]},
      NotebookClose[nb];
      result]];

This will filter out links to guides only:


ClearAll[getGuideLinks];
getGuideLinks[links_List] :=
   Cases[links, l_String /; StringMatchQ[l, "paclet:guide" ~~ __]];

This extracts a name from the link:



ClearAll[nameFromLink];
nameFromLink[link_String] :=
   If[# === {}, Sequence @@ {}, First@#] &@
      StringCases[link, "paclet:guide/" ~~ x__ :> x];

This gets the names of all guides linked from a given one:


Clear[getLinkedGuideNames];
getLinkedGuideNames[guidefile_String] :=
    Map[nameFromLink, getGuideLinks@getLinks@guidefile];


This constructs a list of graph rules from a list of files with guides:


Clear[getGraphRules];
getGraphRules[guideFiles : {__String}] :=
   Flatten[
     Thread[FileBaseName[#] -> getLinkedGuideNames[#]] & /@ 
         guideFiles];

Here is a list of guides:


guides = 
  FileNames["*", 

   "C:\\Program Files\\Wolfram Research\\Mathematica\\
       8.0\\Documentation\\English\\System\\Guides"];

You can now, if you wish, construct a graph as follows:


Graph[Union[getGraphRules[guides]] /. Rule -> DirectedEdge]

but it is a huge graph which visually is not easy to analyze. One obviously needs to analyze it more locally by inducing subgraphs etc.


For convenience of anyone who would like to play with this, I placed the rules obtained with the above code into this gist.


Comments

Post a Comment

Popular posts from this blog

functions - Get leading series expansion term?

Given a function f[x] , I would like to have a function leadingSeries that returns just the leading term in the series around x=0 . For example: leadingSeries[(1/x + 2)/(4 + 1/x^2 + x)] x and leadingSeries[(1/x + 2 + (1 - 1/x^3)/4)/(4 + x)] -(1/(16 x^3)) Is there such a function in Mathematica? Or maybe one can implement it efficiently? EDIT I finally went with the following implementation, based on Carl Woll 's answer: lds[ex_,x_]:=( (ex/.x->(x+O[x]^2))/.SeriesData[U_,Z_,L_List,Mi_,Ma_,De_]:>SeriesData[U,Z,{L[[1]]},Mi,Mi+1,De]//Quiet//Normal) The advantage is, that this one also properly works with functions whose leading term is a constant: lds[Exp[x],x] 1 Answer Update 1 Updated to eliminate SeriesData and to not return additional terms Perhaps you could use: leadingSeries[expr_, x_] := Normal[expr /. x->(x+O[x]^2) /. a_List :> Take[a, 1]] Then for your examples: leadingSeries[(1/x + 2)/(4 + 1/x^2 + x), x] leadingSeries[Exp[x], x] leadingSeries[(1/x + 2 + (1 - 1/x...
Post a Comment
Read more

mathematical optimization - Minimizing using indices, error: Part::pkspec1: The expression cannot be used as a part specification

I want to use Minimize where the variables to minimize are indices pointing into an array. Here a MWE that hopefully shows what my problem is. vars = u@# & /@ Range[3]; cons = Flatten@ { Table[(u[j] != #) & /@ vars[[j + 1 ;; -1]], {j, 1, 3 - 1}], 1 vec1 = {1, 2, 3}; vec2 = {1, 2, 3}; Minimize[{Total@((vec1[[#]] - vec2[[u[#]]])^2 & /@ Range[1, 3]), cons}, vars, Integers] The error I get: Part::pkspec1: The expression u[1] cannot be used as a part specification. >> Answer Ok, it seems that one can get around Mathematica trying to evaluate vec2[[u[1]]] too early by using the function Indexed[vec2,u[1]] . The working MWE would then look like the following: vars = u@# & /@ Range[3]; cons = Flatten@{ Table[(u[j] != #) & /@ vars[[j + 1 ;; -1]], {j, 1, 3 - 1}], 1 vec1 = {1, 2, 3}; vec2 = {1, 2, 3}; NMinimize[ {Total@((vec1[[#]] - Indexed[vec2, u[#]])^2 & /@ R...
Post a Comment
Read more

plotting - Plot 4D data with color as 4th dimension

I have a list of 4D data (x position, y position, amplitude, wavelength). I want to plot x, y, and amplitude on a 3D plot and have the color of the points correspond to the wavelength. I have seen many examples using functions to define color but my wavelength cannot be expressed by an analytic function. Is there a simple way to do this? Answer Here a another possible way to visualize 4D data: data = Flatten[Table[{x, y, x^2 + y^2, Sin[x - y]}, {x, -Pi, Pi,Pi/10}, {y,-Pi,Pi, Pi/10}], 1]; You can use the function Point along with VertexColors . Now the points are places using the first three elements and the color is determined by the fourth. In this case I used Hue, but you can use whatever you prefer. Graphics3D[ Point[data[[All, 1 ;; 3]], VertexColors -> Hue /@ data[[All, 4]]], Axes -> True, BoxRatios -> {1, 1, 1/GoldenRatio}]
Post a Comment
Read more