# The BrailleR package Example 1.

## Histograms

The first and most commonly used example demonstrating the value of the BrailleR package to a blind user is the creation of a histogram.

    x=rnorm(1000)
    VI(hist(x))

    This is a histogram, with the title: Histogram of x
     x is marked on the x-axis.
    There are a total of 1000 elements for this variable.
    It has 14 bins with equal widths, starting at -3.5 and ending at 3.5 .
    The mids and counts for the bins are:
    mid = -3.25  count = 2
    mid = -2.75  count = 12
    mid = -2.25  count = 15
    mid = -1.75  count = 66
    mid = -1.25  count = 88
    mid = -0.75  count = 135
    mid = -0.25  count = 190
    mid = 0.25  count = 197
    mid = 0.75  count = 132
    mid = 1.25  count = 94
    mid = 1.75  count = 48
    mid = 2.25  count = 12
    mid = 2.75  count = 6
    mid = 3.25  count = 3

The VI() command actually calls the VI.histogram() command as the hist() command creates an object of class “histogram”.

## Important features

The VI() command has added to the impact of issuing the hist() command as the actual graphic is generated for the sighted audience. The blind student can read from the text description so that they can interpret the information that the histogram offers the sighted world.

The above example showed the standard implementation of the hist() function. The hist() function of the graphics package does not store the additional arguments that improve the visual attractiveness. The solution (perhaps temporary) is to mask the original function with one included in the BrailleR package that calls the graphics package function, and then adds extra detail for any added plotting arguments.

This is best illustrated using the example included in the BrailleR::hist() function.

    example(hist)

    hist> x=rnorm(1000)

    hist> # the stamdard hist function returns
    hist> MyHist=graphics::hist(x, xlab="random normal values", main="Example histogram (graphics package)")

    hist> #dev.off()
    hist> MyHist
    $breaks
     [1] -3.5 -3.0 -2.5 -2.0 -1.5 -1.0 -0.5  0.0  0.5  1.0  1.5  2.0  2.5  3.0
    [15]  3.5

    $counts
     [1]   1   8  12  48  97 146 193 198 149  88  39  13   7   1

    $density
     [1] 0.002 0.016 0.024 0.096 0.194 0.292 0.386 0.396 0.298 0.176 0.078
    [12] 0.026 0.014 0.002

    $mids
     [1] -3.25 -2.75 -2.25 -1.75 -1.25 -0.75 -0.25  0.25  0.75  1.25  1.75
    [12]  2.25  2.75  3.25

    $xname
    [1] "x"

    $equidist
    [1] TRUE

    attr(,"class")
    [1] "histogram"

    hist> # while this version returns
    hist> MyHist=hist(x, xlab="random normal values", main="Example histogram (BrailleR package)")

    hist> #dev.off()
    hist> MyHist
    $breaks
     [1] -3.5 -3.0 -2.5 -2.0 -1.5 -1.0 -0.5  0.0  0.5  1.0  1.5  2.0  2.5  3.0
    [15]  3.5

    $counts
     [1]   1   8  12  48  97 146 193 198 149  88  39  13   7   1

    $density
     [1] 0.002 0.016 0.024 0.096 0.194 0.292 0.386 0.396 0.298 0.176 0.078
    [12] 0.026 0.014 0.002

    $mids
     [1] -3.25 -2.75 -2.25 -1.75 -1.25 -0.75 -0.25  0.25  0.75  1.25  1.75
    [12]  2.25  2.75  3.25

    $xname
    [1] "x"

    $equidist
    [1] TRUE

    $main
    [1] "Example histogram (BrailleR package)"

    $xlab
    [1] "random normal values"

    attr(,"class")
    [1] "histogram"

    hist> # The VI() method then uses the extra information stored
    hist> VI(MyHist)
    This is a histogram, with the title: Example histogram (BrailleR package)
     random normal values is marked on the x-axis.
    There are a total of 1000 elements for this variable.
    It has 14 bins with equal widths, starting at -3.5 and ending at 3.5 .
    The mids and counts for the bins are:
    mid = -3.25  count = 1
    mid = -2.75  count = 8
    mid = -2.25  count = 12
    mid = -1.75  count = 48
    mid = -1.25  count = 97
    mid = -0.75  count = 146
    mid = -0.25  count = 193
    mid = 0.25  count = 198
    mid = 0.75  count = 149
    mid = 1.25  count = 88
    mid = 1.75  count = 39
    mid = 2.25  count = 13
    mid = 2.75  count = 7
    mid = 3.25  count = 1

## Warning

The VI() function is partially reliant on the use of the hist() function that is included in the BrailleR package. If a histogram is created using a command that directly links to the original hist() command found in the graphics package, then the VI() command’s output will not be as useful to the blind user. This mainly affects the presentation of the title and axis labels; it should not affect the details of the counts etc. within the histogram itself.

This behaviour could arise if the histogram is sought indirectly. If for example, a function offers (as a side effect) to create a histogram, the author of the function may have explicitly stated use of the hist() function from the graphics package using graphics::hist() instead of hist(). Use of graphics::hist() will bypass the BrailleR::hist() function that the VI() command needs. This should not create error messages.