home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / home / misc / 048 / avg.man < prev    next >
Text File  |  1992-07-30  |  6KB  |  146 lines
  1.                        ------------------------------
  2.                        DOCUMENTATION FOR PROGRAM 'AVG'
  3.                        ------------------------------
  4.  
  5.                         Version 1.00 - Copyright 1992
  6.                           Solar Terrestrial Dispatch
  7.  
  8.  
  9.      The utility program AVG runs through the database created by the BCAST
  10. software and generates a list of statistical averages based on the data
  11. contained in the database file.  It will compute a user-defined numerical
  12. average for almost every piece of data contained in the database file.
  13.  
  14.      AVG is executed using the following syntax:
  15.  
  16.       avg [#_of_days_to_average] [start_date:end_date] [R[:start_date]]
  17.  
  18. where the "R" is optional on the command line.  If present, it forces AVG to
  19. compile an extensive report of running averages for the number of days
  20. specified in the "#_of_days_to_average" parameter, beginning with the
  21. start_date given following the "R".  The date is in the format "YYMMDD" and a
  22. colon must separate the "R" from the starting date, if the date is given.  If
  23. the starting date is not given, AVG will begin with the first record in the
  24. database file.  For example, to compute the 20-day running averages starting
  25. on July 1, 1992, you would issue the command: "avg 20 R:920701".  To compute
  26. the 20-day running averages starting with the first date in the database, you
  27. would use the command: "avg 20 R".
  28.  
  29.      Note that only one of the parameters "#_of_days_to_average" OR
  30. "start_date:end_date" can be specified on the command line.  Both cannot be
  31. used together.
  32.  
  33.      If "start_date:end_date" is used, AVG will compute the fixed average
  34. between the two dates given.  If this option is used, you cannot include the
  35. "R" (running average) option, since AVG will not compute the running average
  36. between a fixed set of dates.  The dates given must be in the format: YYMMDD.
  37. For example, to compute the fixed average between June 1, 1992 and June 30,
  38. 1992, you would use the command: "avg 920601:920630".
  39.  
  40.      Consult the list of examples given at the end of this manual for more
  41. information regarding proper syntax.
  42.  
  43.  
  44. FIXED AVERAGES VS RUNNING AVERAGES
  45. ----------------------------------
  46.                 
  47.      AVG will generate two types of reports based on whether the "R" (or
  48. "R"unning Average) command is included on the command line.
  49.  
  50.      A fixed average is simply the numerical average of all of the values
  51. contained in the database file for the last xx number of days in the
  52. database (where "xx" is specified on the command line to AVG), or between the
  53. two dates given on the command line (if dates are used).
  54.  
  55.      For example, to compute the fixed 90-day average of all of data in the
  56. database file, you would type at the DOS prompt: "avg 90".  AVG rapidly
  57. computes the necessary information and sends the generated report to the
  58. standard output device (your screen).  Alternatively, to compute the fixed
  59. average between January 1, 1992 and June 1, 1992, you would type at the DOS
  60. prompt: "avg 920101:920601".
  61.  
  62.      You can redirect the output of AVG to a file by appending the
  63. redirection symbol ">" followed by the name of the file to use.  For example,
  64. to compute the last 27-day fixed averages and save the report in the file
  65. "output.txt", you would type:
  66.  
  67.                 avg 27 > output.txt
  68.  
  69.      Running averages differ from fixed averages in that a stream of average
  70. values are generated as opposed to a single value.
  71.  
  72.      For example, to compute the running 5-day averages of the data in the
  73. database file and save the resulting report to the file "output.txt", you
  74. would type:
  75.  
  76.                 avg 5 R > output.txt
  77.  
  78. This would create an extensive and (depending on the size of your database
  79. file) large report saved in the file "output.txt" containing the running
  80. 5-day averages for each of the values in the BCAST-maintained database file.
  81.  
  82.      When computing the running averages, AVG will automatically attempt to
  83. detect invalid or missing data in the database file which might otherwise
  84. influence the computed averages.  If invalid or missing data is detected, it
  85. will ignore it and report the date of the ignored data on-screen.
  86.  
  87.      There is no limit to the number of days you may compute fixed or running
  88. averages.
  89.  
  90.      AVG may be executed from any directory provided you have set the BCAST
  91. environment variable to point to the area where the database file resides
  92. (see the BCAST manual [BCAST.MAN] for more information regarding the BCAST
  93. environment variable).
  94.  
  95.  
  96. EXAMPLES
  97. --------
  98.  
  99.         avg 5
  100.  
  101. Computes the 5-day averages and displays the averages on the screen.
  102.  
  103.  
  104.         avg 90 > average.txt
  105.  
  106. Computes the 90-day fixed averages and saves the report in the file
  107. "average.txt".
  108.  
  109.  
  110.         avg 27 R > report.doc
  111.  
  112. Computes the 27-day running averages and saves the report in the file
  113. "report.doc".
  114.  
  115.  
  116.         avg 7 R:920710
  117.  
  118. Computes the 7-day running averages beginning with the report for July 10,
  119. 1992 and displays the results on the screen.
  120.  
  121.  
  122.         avg 14 R:911224 > running.txt
  123.  
  124. Computes the 14-day running averages starting with the report for December 24,
  125. 1991 and saves the report to the file "running.txt".
  126.  
  127.  
  128.         avg 920601:920630 > output.fil
  129.  
  130. Calculates the fixed averages for the dates between June 01, 1992 and
  131. June 30, 1992 and saves the report to the file "output.fil".
  132.  
  133.  
  134.         avg 911101:920701 > big_avg.txt
  135.  
  136. Computes the fixed averages between November 01, 1991 and July 01, 1992 and
  137. saves the results to the file "big_avg.txt".
  138.  
  139.  
  140.         avg 9999 > all_avg.txt
  141.  
  142. Computes the fixed averages spanning all of the dates in the database (AVG
  143. will rescale the "9999" to the number of records existing in your database),
  144. and saves the result to the file "all_avg.txt".
  145.  
  146.