home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / t / tau / !Tau / !Help < prev    next >
Encoding:
Text File  |  1994-11-05  |  23.4 KB  |  466 lines

  1.  
  2. Tau, version 1.20
  3.  
  4. Copyright © Tim Birks 1993, 1994
  5. Freeware: for conditions of use, see the file ReadMe.
  6.  
  7. Desktop graph preparation software. Tau generates publication-quality graphs
  8. in the form of Draw files, ready to import into your favourite word-processor
  9. or DTP. A data worksheet (16 columns by 2048 rows) can be filled by keying-
  10. in, importing from a file, and/or calculation. You determine line patterns
  11. and thicknesses, text positioning and font sizes, etc. The data worksheet can
  12. be redimensioned, if you would prefer more rows of data for example.
  13.  
  14. Note that Tau does not draw graphs on the screen (Acorn's excellent Draw
  15. application will do that). In the following text, all references to 'drawing'
  16. or 'plotting' a graph refer to the construction of a Draw file.
  17.  
  18. This file is intended to be some kind of help, but no way is it
  19. comprehensive. It assumes some experience with graph drawing packages, common
  20. sense, and a willingness to suck-it-and-see.
  21.  
  22. -----------------------------------------------------------------------------
  23.  
  24. Important changes from version 1.10.
  25.  
  26. Actually, there are quite a few changes, like the resizable worksheet (with
  27. twice the previous capacity), and the Plot (many) option. The most
  28. significant change is that the TauFile and TauStyle formats are different.
  29. Old-type files can be read by Tau 1.20, but the new-type files cannot be
  30. read by Tau 1.10 and earlier versions. In other words, if you get rid of
  31. your old version of Tau there shouldn't be any problems.
  32.  
  33. -----------------------------------------------------------------------------
  34.  
  35. Starting Tau.
  36.  
  37. Double-click on the !Tau icon in a filer window, or double-click on the icon
  38. of a file of type 082 (TauFile) or 083 (TauStyle). The Tau icon is installed
  39. on the icon bar, and the application's main window opens, showing the data
  40. worksheet (dark blue background) with labelling (grey background) along the
  41. top and left edges.
  42. If starting by a double-click on a TauFile or TauStyle, that file is loaded
  43. into Tau. If starting by a double-click on the !Tau icon itself, Tau looks
  44. for a TauFile or TauStyle called "Default" within the !Tau directory and
  45. loads that. If there is no such file, Tau starts with its worksheet empty
  46. and with minimal appearance data.
  47.  
  48. -----------------------------------------------------------------------------
  49.  
  50. Default settings.
  51.  
  52. There are three ways Tau can get its default settings when it is started.
  53. These include the graph style parameters, and also other things like
  54. whether the user is prompted if unsaved data is about to be lost, and
  55. whether Tau automatically scales your graph.
  56.  
  57. 1) If Tau is started by double-clicking on a TauFile or TauStyle icon, the
  58. defaults are set to the values stored in the file.
  59.  
  60. 2) If Tau is started "empty", by double-clicking on the !Tau icon, the
  61. defaults are obtained from a file called "Default" within the !Tau
  62. directory. If you would like to use your own set of defaults, just put them
  63. in a TauStyle file and save it as "Default" in the !Tau directory.
  64.  
  65. 3) If there is no file "Default" in the !Tau directory and Tau is started
  66. by double-clicking on the !Tau icon, a set of default defaults from within
  67. the program is used.
  68.  
  69. -----------------------------------------------------------------------------
  70.  
  71. Editing data.
  72.  
  73. The data worksheet is arranged in 16 columns, each containing 1024 rows of
  74. cells. The cells can be filled with data by importing from a file (see
  75. below), by calculation (see below), or from the keyboard. Click on the
  76. appropriate cell with Select to set the caret and highlight. You can then
  77. edit the contents of the cell. Valid contents are: a number (use 'E' for
  78. exponential notation); no contents (blank cell); or the special entry 'M'
  79. (for 'move') which will cause any eventual line graph to have a break at
  80. that position.
  81. If you click on a cell with Adjust, the caret does not move, but all the
  82. cells in a rectangle between the caret-cell and the cell you clicked on will
  83. highlight. Any action performed at the caret (followed by RETURN when
  84. entering a number) will then affect all these cells.
  85. Tau keeps a note of the maximum row and column numbers for which data are held. If you double-click on a cell, that cell gains the caret and the whole
  86. column (down to the maximum row) will highlight. Double-click with SHIFT to
  87. highlight a whole row instead.
  88. Values are displayed in cells to six significant figures.
  89.  
  90. -----------------------------------------------------------------------------
  91.  
  92. Special key presses.
  93.  
  94. RETURN -       Reflect the value in the current cell in all highlit cells,
  95.                then move the caret down one row.
  96. SHIFT-RETURN - As RETURN, but move the caret right one column.
  97. CTRL-RETURN -  Carriage return, move down one row, and to leftmost column. 
  98. LEFT/RIGHT -   Move caret one character left/right.
  99. BACKSPACE -    Delete the character to the left of the caret within a cell.
  100. DOWN/UP -      Move caret down/up one cell.
  101. SHIFT-DOWN/UP/LEFT/RIGHT - Extend or contract the highlit block of cells.
  102. CTRL-DOWN/UP - Move caret to the last/first cell in a column.
  103. TAB -          Move caret right one cell, perform 'carriage return' if at the
  104.                last column.
  105. SHIFT-TAB -    Move caret left one cell, perform 'reverse carriage return' if
  106.                at the first column.
  107. HOME -         Move caret to the first cell in the worksheet.
  108. SHIFT-COPY (ie, END) - Move caret to the bottom-right-most cell of a
  109.                rectangle enclosing all cells containing data.
  110. CTRL-U -       Blank all highlit cells.
  111. DELETE -       Same action as BACKSPACE.
  112. SHIFT-DELETE - All highlit cells in the same row as the caret are blanked,
  113.                then all the values in the cells below these are scrolled up
  114.                to 'fill the hole'.
  115. INSERT -       The values in all highlit cells in the same row as the caret,
  116.                and the cells below these, are scrolled down. A row of blank
  117.                cells is inserted.
  118.  
  119. -----------------------------------------------------------------------------
  120.  
  121. Dragging files onto the main window (or the icon bar icon).
  122. This starts a load action which depends on the filetype of the file dragged:
  123.  
  124. 082 (TauFile) - A TauFile file is a complete record of a previous state of
  125.  Tau, and includes all the data in a worksheet and the variables governing
  126.  the appearance of a graph. Dragging a TauFile onto Tau will restore the
  127.  saved state, overwriting all of the current state.
  128. 083 (TauStyle) - A TauStyle file is a TauFile file without any worksheet
  129.  data. It replaces the variables governing the appearance of a graph, without
  130.  overwriting the current data. It's like the 'template' files in other graph
  131.  software, but the word 'template' already has a very particular meaning in
  132.  RISC OS.
  133. ffb (BASIC) - Has no immediate effect. Tau assumes any imported BASIC file
  134.  to be a function library. You can then perform calculations on worksheet
  135.  data using your own defined functions. A simple example, Sinc, is provided
  136.  with Tau - this contains a function FNsinc(x) which returns SIN(x)/x without
  137.  generating an error at x=0. To avoid clashes with the program's internal FN
  138.  definitions, do not use FN names beginning with capital 'T'.
  139. fff (Text), dfe (CSV) - Tau assumes files of these types contain textual data
  140.  for import, either separated by spaces or commas, with row endings marked
  141.  by one or more control characters (such a linefeed or carriage-return).
  142.  Import starts at the caret; data in cells not explicitly overwritten by new
  143.  data are retained. Incidentally, Tau treats these files identically on
  144.  import - eg the contents of a Text file can be comma- separated. A blank
  145.  cell can be marked by an isolated decimal '.', and a 'move' cell by 'M'.
  146. Other filetypes - action is normally as for fff (Text). But Tau first
  147.  investigates whether the file might contain non-textual numerical data
  148.  ("Binary data"). Such a file would be generated by, for example, the Basic
  149.  PRINT# statement. Tau assumes that your file is "Binary data" if the first
  150.  byte in the file is ascii &40, &80 or &88; no self-respecting file of
  151.  textual data should contain any of these characters.
  152.  Because there is no row-ending marker in such a file, Tau expects a special
  153.  first datum in the file to be an integer specifying the number of data
  154.  columns in one row. However, you can instead specify the number of columns
  155.  in the Import dbox. Import starts at the caret; data not overwritten are
  156.  retained.
  157.  
  158. -----------------------------------------------------------------------------
  159. -----------------------------------------------------------------------------
  160.  
  161. Main menu.
  162.  
  163. Click Menu over the main window, gives the following items:
  164.  
  165. Paper - Leads to a submenu controlling the size and shape of a graph on the
  166.  paper.
  167. Graph - Leads to a submenu controlling the appearance of the whole graph.
  168.  This includes such attributes as its scaling and the appearance of ticks
  169.  and labels, and the number of rows and columns in the worksheet.
  170. Column - Leads to a submenu controlling the treatment of an individual column
  171.  of data. This includes control of the meaning of a column (use as X data, Y
  172.  data, error bar data, or ignore), the appearance of a plot (whether to draw
  173.  points, lines between points, etc), and actions such as calculation and
  174.  sort.
  175. Save - Leads to a submenu allowing the saving of data in various ways.
  176.  Clicking on the Save item in the Main menu will save the current Tau state
  177.  as a TauFile, or generate an error if no pathname is specified yet.
  178. Import - Leads to a dialogue box. The first part governs the import of a
  179.  file of Binary data (see above). The second part allows you to "weed" data
  180.  being imported, reading in only 1 row of data for each n rows of data in the
  181.  file.
  182. Cells - A submenu, various ways of highlighting parts of the worksheet.
  183. Reduce - A submenu, various ways to shrink your data, and disable the
  184.  warning Tau gives when edited data is about to be lost or over-written.
  185.  
  186. -----------------------------------------------------------------------------
  187.  
  188. Paper submenu.
  189.  
  190. The items in this submenu lead to dialogue boxes. All dimensions are in
  191. points (1/72 inch) unless otherwise specified.
  192.  
  193. + Size dbox.
  194. This governs the size and positioning, on paper, of the three main separate
  195.  structures in a Tau graph. All sizes are in INCHES. (Aside, to any Euro-
  196.  freaks: the 'inch' is a special Tau unit of length defined to be equal to
  197.  72 points. Happy now?)
  198. Graph - This is actually the size and position of the graph's viewport, ie
  199.  the frame if one is being drawn.
  200. Border - You can have a border to make your graph look pretty. However, the
  201.  main reason for having one is for grid-locking in !Draw. The average graph
  202.  will have a well-defined frame, but also all sorts of labels and text
  203.  hanging off it. The Draw bounding box of the graph will therefore not be
  204.  simply related to the frame, and will vary from graph to graph. This causes
  205.  problems when trying to arrange two or more graphs to line up nicely when
  206.  using gridlock in Draw. So Tau can draw a big well-defined border around the
  207.  whole lot. Then you can line your graphs up in Draw, then delete the frames
  208.  afterwards. Since the border is meant to be a throw-away structure, it will
  209.  always be 'thin'. That's the theory anyway; shame it doesn't work.
  210. Key - A really simple-minded key to the graph can be drawn, more as a
  211.  reminder than anything else. The key is a list of the Y plots drawn, showing
  212.  the line pattern, the point shape, and a bit of text.
  213.  
  214. + Magnify dbox.
  215. The whole graph can be magnified (or shrunk) uniformly when saved as a Draw
  216.  file. Enter the magnification factor here.
  217.  
  218. -----------------------------------------------------------------------------
  219.  
  220. Graph submenu.
  221.  
  222. The items in this submenu lead to dialogue boxes. All dimensions are in
  223. points (1/72 inch) unless otherwise specified.
  224.  
  225. + Scaling dbox.
  226. Governs the scaling of the graph. All dimensions refer to the data in the
  227. worksheet.
  228. Auto scale - When selected, Tau takes a look at the worksheet and your other
  229.  choices, and automatically scales the graph. Deselect it if you want to
  230.  make any changes yourself.
  231. Bound - When selected, the graph will include only data points and line
  232.  segments within the frame of the graph. Otherwise points and lines outside
  233.  the frame will be drawn also. N.B. the Bound feature is bug-ridden, so I
  234.  have disabled it!
  235. X/Y log scale - Whether or not a log scale is selected governs the type of
  236.  scaling information required, below. Beware negative or zero values!
  237. X/Y values - Determines the range of the graph's viewport, and the
  238.  positioning of axes within it.
  239. Format - Determines the appearance of numerical axis labels. The choices
  240.  follow BASIC's @% format.
  241. X/Y tick spacing - Tau supports two sets of ticks on each axis, major ticks
  242.  usually being more prominent than minor ticks. The anchor is any one value
  243.  where a major tick is to lie. Hence if the tick spacing is '2' and the
  244.  anchor is '5', then major ticks will be drawn at 1,3,5,7,...
  245. If a log scale is selected, you can follow the linear settings, but that gets
  246.  a bit unbalanced if your graph extends over more than a decade or so.
  247.  Alternatively, select a logarithmic tick distribution; for example, if
  248.  '1,3,10' is selected then ticks will be drawn at 0.1,0.3,1,3,10,30,...
  249.  
  250. + Frame dbox.
  251. Governs the axis structures to be drawn. All dimensions are in points.
  252.  A frame is a rectangular box at the edge of the graph's viewport, and
  253.  carries ticks on all four sides. An X/Y axis is a horizontal/vertical bar
  254.  which stretches the whole length/height of the viewport and can be
  255.  positioned anywhere vertically/horizontally (as defined in the Scaling
  256.  dbox).
  257.  
  258. + Ticks dbox.
  259. Governs the appearance of axis/frame ticks. All dimensions in points.
  260.  Tau supports two sets of ticks on each axis; major ticks usually being more
  261.  prominent than minor ticks. Ticks on an X axis extend up and/or down. Ticks
  262.  on a Y axis extend left and/or right. Ticks on a frame extend in and/or out.
  263.  You can choose whether to plot a certain family of ticks at all.
  264.  
  265. + Grids dbox.
  266. Governs the appearance of grid lines. All dimensions in points.
  267.  Grid lines are usually broken or dashed, so you choose the dash pattern.
  268.  Grid lines are anchored to ticks, but can omit the minor ticks.
  269.  
  270. + Labels dbox.
  271. Governs the appearance and positioning of numerical labels on axes/frame.
  272. Labels can appear on axes and/or the frame.
  273. Below ? - When selected, labels are placed below the X axis or frame bottom
  274.  edge. Otherwise labels are placed above the X axis or frame top edge.
  275. Left ? - Analogous to Below ? but for Y values.
  276. Minors ? - When selected, labels are placed at minor ticks as well as major
  277.  ticks.
  278. Rotate ? - When selected, Y labels are written 'sideways' parallel to the
  279.  axis or frame edge. THIS OPTION FAILS IN RISC OS 2 !!!
  280. Offset - The distance between the axis or frame and the label, as a fraction
  281.  of the font height/width.
  282. Font Size - In points. The label font is determined in the Fonts dbox.
  283.  
  284. + Texts dbox.
  285. Governs the appearance of textual labels on axes/frames, such as a
  286.  description of the quantity plotted along an axis.
  287. plot? - Whether to draw at all.
  288. on Frame? - When selected, plot along the frame, else along the axis.
  289. below?/left?/rotate? - As in the Labels dbox.
  290. Offset - The distance between the frame/axis and the nearest part of the
  291.  text, as a fraction of the font height/width.
  292. Spacing - The line spacing between successive lines of the text, as a
  293.  fraction of the font height/width.
  294. Text - Any text you like. Include backslash characters '\' to force a line
  295.  break.
  296. Font size - In points. Uses the same font as the numerical labels, but can
  297.  be a different size.
  298.  
  299. + Fonts dbox.
  300. There are usually two fonts in use in a Tau graph. You have to enter in their
  301. full names in this dbox.
  302. Font for data points - This should be some kind of symbolic font to supply
  303.  circles, squares, triangles, stars, etc for data points. Specifically use
  304.  the Selwyn font. However, maybe Selwyn only comes with RISC OS 3, I don't
  305.  know. So you can choose to use another font instead if you like. The public
  306.  domain Dingbats font should do the trick.
  307. Font for graph labels - This serves for all labelling tasks.
  308.  
  309. + Worksheet dbox.
  310. This displays the current number of rows and columns in the data worksheet,
  311.  and invites you to enter new values for either or both. If you enter a new
  312.  value for just one, then the other will be given the maximum possible range.
  313.  If you specify fewer rows than the current data, or if you change the number
  314.  of columns at all, the current data will be forgotten! The maximum number
  315.  of columns is 64.
  316.  
  317. -----------------------------------------------------------------------------
  318.  
  319. Column submenu.
  320.  
  321. All but one of the items in this submenu lead to dialogue boxes.
  322.  
  323. + Plot dbox.
  324. Governs the appearance of a column of Y data points. All dimensions in
  325. points. Acts only on the column which includes the caret.
  326. Plot this Column - When deselected, Tau ignores the column of data
  327.  completely.
  328. Draw Line - When selected, draw straight lines between successive X,Y points.
  329.  Define your own dash patterns. If a value 'M' is encountered on either the
  330.  X or Y data, the line will be broken by a 'move' operation; line drawing
  331.  resumes from the next numerical value.
  332. Draw Error Bars - If selected, when drawing the graph, Tau looks for any
  333.  columns designated Ln, Rn, Un, Dn, Hn and Vn, for the appropriate n, to
  334.  supply error bar data to the graph. If none are found, no error bars are
  335.  drawn.
  336. Key Text - The text to appear in the graph key (if plotted).
  337. Fill - Fill the area between the graph line (which of course is not plotted
  338.  if Draw Line is deselected) and the X axis, in the selected Desktop colour.
  339.  This is not done if a Y log scale is selected or if Bound ? is selected.
  340.  Expect peculiar effects if your plot includes moves (an 'M' in the
  341.  worksheet).
  342. Draw Points - When selected, mark data points with characters from the font
  343.  selected in the Fonts dbox. You choose the character size and ascii code -
  344.  an enlarged picture of the character is shown.
  345.  
  346. + Meaning dbox.
  347. You decide the meaning to attach to the data in the column. A string
  348. summarising your choice is shown along the top of the worksheet for your
  349. information. Valid designations are:
  350.  X - The column is to supply the X data for a graph. You need one of these
  351.    somewhere to get a graph!
  352.  Yn (where n is any digit or pair of digits) - The column is to supply a set
  353.    of Y data. Since many sets of Y data can be plotted in Tau, each is
  354.    distinguished by the tag n.
  355.  Ln/Rn/Un/Dn - Error bar length left/right/up/down, to attach to the series
  356.    of data points given by the selected X and Yn. For example, a column
  357.    designated U3 supplies 'up' error bar information for use with the column
  358.    designated Y3.
  359.  Hn/Vn - Combines Ln & Rn / Un & Dn designations; that is, provides
  360.    horizontal/vertical error bar lengths in both directions.
  361. When constructing a graph, Tau looks for the first occurrence of a given
  362. column meaning and ignores any others. For example, if you have two columns
  363. both designated 'X", the second will be ignored.
  364.  
  365. + Plot (many) dbox.
  366. This performs the actions of the "Plot" dbox on a number of columns, the
  367.  parameters being set to the values for the current column (the one the
  368.  caret is sitting in).
  369. To determine which columns to act upon, type an appropriate string into the
  370.  writable icon. This string can be either:
  371.  1) A list of column numbers separated by commas, including ranges. For
  372.     example, "3,6-9,11" will act on columns 3, 6, 7, 9 and 11; or
  373.  2) A BASIC logical expression which includes the "#" character. The program
  374.     substitutes the # for each column number in turn. Those columns for
  375.     which the expression is TRUE are acted upon. For example, the string
  376.     "(# MOD2)=0" acts only on the even numbered columns, and "#>5 AND #<9"
  377.     acts only on columns 6, 7 and 8.
  378. The column's tag number can also be changed. Specify a BASIC expression with
  379.  the "#" character again specifying the column number.
  380.  
  381. + Calculate dbox.
  382. To fill the highlit area of the column with the caret with the results of a
  383.  calculation, enter a valid BASIC expression. To use values from worksheet
  384.  column n as arguments, use #n; to use values from the selected column, use
  385.  #@; to use the row number (the number shown down the left side of the
  386.  worksheet), use ##.
  387. For example, if you want to plot a graph of EXP(X) versus X, from -5 to 5 in
  388.  50 steps. Start with an empty worksheet. Highlight rows 0 to 50 in column 0.
  389.  In the Calculate dbox, enter the expression: (##-25)/5, to give values from
  390.  -5 to 5. Double-click on column 1 to highlight rows 0 to 50, then calculate:
  391.  EXP(#0). Designate column 0 as 'X' and column 1 as, for example, 'Y1'.
  392. You can define your own functions for use in calculations: write a BASIC
  393.  library containing the FN definition, then drag the BASIC file onto the Tau
  394.  main window. Tau will install the library. Make sure the function name
  395.  doesn't begin FNT..., to guarantee no conflict with Tau's internal FN
  396.  definitions. A simple example 'Sinc' is included.
  397. You can also use Calculate to copy or move data from one column to another -
  398.  for example, to copy column 3, use the expression: #3.
  399.  
  400. + Best fit dbox.
  401. Performs linear/log regression (depending on whether X/Y log scales are
  402.  currently selected) on X,Y data supplied by the selected rows of the data
  403.  columns designated X and Yn respectively. You select the Yn to use - note
  404.  this is NOT the column number, but the Y tag. The Y values given by the
  405.  regression are then inserted into the highlit columns. You can force the
  406.  regression to pass through a given point (usually the origin).
  407.  
  408. + Normalise.
  409. Finds the maximum absolute value in the highlit area, then divides all
  410.  highlit cells by that value.
  411.  
  412. + Sort.
  413. When the item is clicked, the highlit rows across all columns are sorted in
  414.  ascending order of the values in the highlit column.
  415.  
  416. -----------------------------------------------------------------------------
  417.  
  418. Save submenu.
  419.  
  420. All items but one lead to a Save dialogue box.
  421.  
  422. + Draw file
  423. THIS IS THE PRIMARY OUTPUT OF TAU !!!  Saving a Draw file initiates the
  424.  construction of the graph as defined by the values in the worksheet and the
  425.  various style variables. The resultant Draw file can be imported directly
  426.  into other applications, or edited using !Draw; for example, if you want to
  427.  combine several graphs onto one diagram, or if you want to change the fill
  428.  colour of a 'fill' plot.
  429.  
  430. + Tau file
  431. Makes a copy of the complete state of Tau in a file of type 082 (TauFile).
  432.  However, information about any user function libraries currently in place is
  433.  not saved.
  434.  
  435. + Tau style
  436. The Tau equivalent of a graphics template file, to make it easier to produce
  437.  a batch of graphs with the same style.
  438.  
  439. + CSV data
  440. Export data from the worksheet in the form of textual CSV (comma separated
  441.  values). Export is influenced by the selections made in the Options dbox
  442.  (see below).
  443.  
  444. + Text data
  445. Export data in the form of spaced text. Also uses Options dbox.
  446.  
  447. + Binary data
  448. Export numerical data in BASIC PRINT# format. This saves space. The first
  449.  datum in the file is an integer indicating the number of columns the data
  450.  spans. Also uses Options dbox.
  451.  
  452. + Options dbox
  453. This is a dbox of data export options. Choose to use an isolated point
  454.  character '.' to mark blank cells, an 'M' character to mark 'move' cells,
  455.  whether to export data in order of meaning (Y1, Y2, etc) or not, whether
  456.  to export the whole worksheet or just a highlit selection, and whether to
  457.  export the number of columns as the first datum when saving a Binary file.
  458.  
  459. -----------------------------------------------------------------------------
  460.  
  461. Quitting Tau.
  462.  
  463. If you click on the Close icon of the main window, you do not actually leave
  464.  Tau: clicking on the icon bar icon restores the main window unchanged. To
  465.  quit Tau, select Quit from the icon bar menu.
  466.