SetOptions: Functions for setting package options.
In BrailleR: Improved Access for Blind Users
SetOptions R Documentation
Functions for setting package options.
Description
Some package options have arguments which need validation. Setting the default significance level for analyses was the first function of this kind. Setting the name of the user to be inserted into documents was the second. Others are detailed further below.
Usage
ChooseEmbosser(Embosser = "none", Permanent = interactive(), Local = interactive())
ChooseStyle(css = "BrailleR.css", Permanent = interactive(), Local = interactive())
ChooseSlideStyle(css = "JGSlides.css", Permanent = interactive(), Local = interactive())
ResetDefaults(Local = interactive())
SetAuthor(name = "BrailleR", Permanent = interactive(), Local = interactive())
SetBRLPointSize(pt, Permanent = FALSE, Local = interactive())
SetPaperHeight(Inches, Permanent = FALSE, Local = interactive())
SetPaperWidth(Inches, Permanent = FALSE, Local = interactive())
SetLanguage(Language = "en_us", Permanent = interactive(), Local = interactive())
SetMakeUpper(Upper, Permanent = interactive(), Local = interactive())
SetPValDigits(digits, Permanent = interactive(), Local = interactive())
SetSigLevel(alpha, Permanent = interactive(), Local = interactive())
Arguments
alpha
The level of alpha to be used for analyses. Must be between zero and one or a warning is given and the option is not changed.
css
a cascading style sheet file to be inserted in HTML documents created by convenience functions. The file must be placed in the css folder within the MyBrailleR folder created by the user when prompted, for this to work.
digits
The number of decimal places to display. Must be an integer greater than one or a warning is given and the option is not changed.
Embosser
the name of the embosser to be used for tactile images. Not all embossers will be immediately supported by the package. The supported embossers are listed in the relevant section below. Please contact the package maintainer to introduce a new embosser to the list of supported models.
Inches
The size of the area to use for embossing. This should be the size of the embossed area not the actual size of the paper itself.
Language
The character string for the language files to be used in spell checking.
Local
Should the local copy of BrailleROptions be updated?
name
a character string to be used for author details in various file writing functions.
Permanent
Should the change be made permanent? Set to FALSE for a temporary change.
pt
The point size of the chosen braille font.
Upper
Should the initial letter of variable names be capitalised in captions and filenames? Logical, initially set to TRUE.
Details
More convenience functions for BrailleR users. Most are self explanatory, but the following details should be noted.
The Choose...() functions are used for establishing default parameters for other details. The ChooseStyle() command can be used to alter the appearance of HTML output by way of cascading style sheets. You can create your own css file and add it to your user folder called MyBrailleR before calling this function.
The ChooseEmbosser() will look for the default settings recommended for particular types of embosser. Initial testing was done on a Tiger Premier 100 embosser manufactured by ViewPlus Inc. The default paper size is 11 by 11.5 inches, but the recommended embossing area for graphics is 10 by 10 inches. Please submit your preferences for any embosser to the package maintainer.
The Set..() commands will let the user specify any desired value for the options as long as it is valid: Options assumed to be character strings are checked to be so, integers must be integers and a proportion must be between zero and one.
SetPaperHeight and SetPaperWidth are temporary changes by default because some types of images are not meant to use the maximum area set down by the original default settings for an embosser. Careful experimentation may be required to get optimal results. If permanent changes are desired, then please contact the package maintainer to explain why you have made these changes so that we can help other users get the best from a wide range of embossers.
SetPValDigits() is used for rounding purposes to avoid the use of scientific notation. It is not used for determining significance.
Value
NULL. These functions set package options.
Author(s)
A. Jonathan R. Godfrey
Examples
# SetSigLevel(5) # not a valid alpha
SetSigLevel(0.05, Local=FALSE) # valid alpha value
SetAuthor(Local=FALSE)
SetAuthor("Jonathan Godfrey", Local=FALSE)
BrailleR documentation built on July 26, 2023, 5:46 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| SetOptions | R Documentation |
Functions for setting package options.
Description
Some package options have arguments which need validation. Setting the default significance level for analyses was the first function of this kind. Setting the name of the user to be inserted into documents was the second. Others are detailed further below.
Usage
ChooseEmbosser(Embosser = "none", Permanent = interactive(), Local = interactive())
ChooseStyle(css = "BrailleR.css", Permanent = interactive(), Local = interactive())
ChooseSlideStyle(css = "JGSlides.css", Permanent = interactive(), Local = interactive())
ResetDefaults(Local = interactive())
SetAuthor(name = "BrailleR", Permanent = interactive(), Local = interactive())
SetBRLPointSize(pt, Permanent = FALSE, Local = interactive())
SetPaperHeight(Inches, Permanent = FALSE, Local = interactive())
SetPaperWidth(Inches, Permanent = FALSE, Local = interactive())
SetLanguage(Language = "en_us", Permanent = interactive(), Local = interactive())
SetMakeUpper(Upper, Permanent = interactive(), Local = interactive())
SetPValDigits(digits, Permanent = interactive(), Local = interactive())
SetSigLevel(alpha, Permanent = interactive(), Local = interactive())
Arguments
alpha |
The level of alpha to be used for analyses. Must be between zero and one or a warning is given and the option is not changed. |
css |
a cascading style sheet file to be inserted in HTML documents created by convenience functions. The file must be placed in the css folder within the MyBrailleR folder created by the user when prompted, for this to work. |
digits |
The number of decimal places to display. Must be an integer greater than one or a warning is given and the option is not changed. |
Embosser |
the name of the embosser to be used for tactile images. Not all embossers will be immediately supported by the package. The supported embossers are listed in the relevant section below. Please contact the package maintainer to introduce a new embosser to the list of supported models. |
Inches |
The size of the area to use for embossing. This should be the size of the embossed area not the actual size of the paper itself. |
Language |
The character string for the language files to be used in spell checking. |
Local |
Should the local copy of BrailleROptions be updated? |
name |
a character string to be used for author details in various file writing functions. |
Permanent |
Should the change be made permanent? Set to FALSE for a temporary change. |
pt |
The point size of the chosen braille font. |
Upper |
Should the initial letter of variable names be capitalised in captions and filenames? Logical, initially set to TRUE. |
Details
More convenience functions for BrailleR users. Most are self explanatory, but the following details should be noted.
The Choose...() functions are used for establishing default parameters for other details. The ChooseStyle() command can be used to alter the appearance of HTML output by way of cascading style sheets. You can create your own css file and add it to your user folder called MyBrailleR before calling this function.
The ChooseEmbosser() will look for the default settings recommended for particular types of embosser. Initial testing was done on a Tiger Premier 100 embosser manufactured by ViewPlus Inc. The default paper size is 11 by 11.5 inches, but the recommended embossing area for graphics is 10 by 10 inches. Please submit your preferences for any embosser to the package maintainer.
The Set..() commands will let the user specify any desired value for the options as long as it is valid: Options assumed to be character strings are checked to be so, integers must be integers and a proportion must be between zero and one.
SetPaperHeight and SetPaperWidth are temporary changes by default because some types of images are not meant to use the maximum area set down by the original default settings for an embosser. Careful experimentation may be required to get optimal results. If permanent changes are desired, then please contact the package maintainer to explain why you have made these changes so that we can help other users get the best from a wide range of embossers.
SetPValDigits() is used for rounding purposes to avoid the use of scientific notation. It is not used for determining significance.
Value
NULL. These functions set package options.
Author(s)
A. Jonathan R. Godfrey
Examples
# SetSigLevel(5) # not a valid alpha
SetSigLevel(0.05, Local=FALSE) # valid alpha value
SetAuthor(Local=FALSE)
SetAuthor("Jonathan Godfrey", Local=FALSE)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.