Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
jbryer committed Sep 30, 2014
1 parent b064803 commit e9907cd
Show file tree
Hide file tree
Showing 31 changed files with 54 additions and 53 deletions.
2 changes: 1 addition & 1 deletion NAMESPACE
@@ -1,4 +1,4 @@
# Generated by roxygen2 (4.0.1): do not edit by hand
# Generated by roxygen2 (4.0.2): do not edit by hand

S3method(plot,likert)
S3method(plot,likert.gap)
Expand Down
1 change: 1 addition & 0 deletions likert.dev.R
Expand Up @@ -7,6 +7,7 @@ setwd("~/Dropbox/Projects") #Mac
document("likert")
check_doc("likert")
install("likert")
build('likert')
check("likert", cran=TRUE)
build('likert',vignettes=FALSE)

Expand Down
2 changes: 1 addition & 1 deletion man/MathAnxiety.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{data}
\name{MathAnxiety}
\alias{MathAnxiety}
Expand Down
2 changes: 1 addition & 1 deletion man/MathAnxietyGender.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{data}
\name{MathAnxietyGender}
\alias{MathAnxietyGender}
Expand Down
2 changes: 1 addition & 1 deletion man/abs_formatter.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{abs_formatter}
\alias{abs_formatter}
\title{Absolute value formatter for continuous_scale}
Expand Down
2 changes: 1 addition & 1 deletion man/align.plots.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{align.plots}
\alias{align.plots}
\title{Adapted from ggExtra package which is no longer available. This is related to
Expand Down
2 changes: 1 addition & 1 deletion man/gap.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{data}
\name{gap}
\alias{gap}
Expand Down
2 changes: 1 addition & 1 deletion man/label_wrap_mod.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{label_wrap_mod}
\alias{label_wrap_mod}
\title{Wrap label text.}
Expand Down
2 changes: 1 addition & 1 deletion man/likert-package.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{package}
\name{likert-package}
\alias{likert-package}
Expand Down
2 changes: 1 addition & 1 deletion man/likert.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{likert}
\alias{likert}
\title{Analyze Likert type items.}
Expand Down
2 changes: 1 addition & 1 deletion man/likert.bar.plot.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{likert.bar.plot}
\alias{likert.bar.plot}
\title{Bar Plot for Likert Items.}
Expand Down
2 changes: 1 addition & 1 deletion man/likert.density.plot.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{likert.density.plot}
\alias{likert.density.plot}
\title{Creates a density plot for likert items.}
Expand Down
6 changes: 3 additions & 3 deletions man/likert.heat.plot.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{likert.heat.plot}
\alias{likert.heat.plot}
\title{Internal method.}
Expand All @@ -13,10 +13,10 @@ likert.heat.plot(likert, low.color = "white", high.color = "blue",

\item{high.color}{color for high values.}

\item{text.size}{size of text attributes.}

\item{text.color}{color of text attributes.}

\item{text.size}{size of text attributes.}

\item{wrap}{width to wrap label text for non-grouped likert objects.}

\item{...}{currently unused.}
Expand Down
10 changes: 5 additions & 5 deletions man/likert.histogram.plot.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{likert.histogram.plot}
\alias{likert.histogram.plot}
\title{Histogram of number of responses.}
Expand Down Expand Up @@ -28,15 +28,13 @@ complete values.}
\item{label.missing}{the label to use in the legend representing the count of
missing values.}

\item{order}{the order of the items.}

\item{...}{other ggplot2 parameters.}

\item{legend.position}{the position for the legend ("left", "right", "bottom",
"top", or two-element numeric vector).}

\item{wrap}{width to wrap label text for item labels}

\item{order}{the order of the items.}

\item{group.order}{the order in which groups (for grouped items) or items
(for non-grouped items) should be plotted.}

Expand All @@ -47,6 +45,8 @@ Possible values are \code{v} (vertical, the default), \code{h}
\item{panel.strip.color}{the background color for panel labels.}

\item{text.size}{size of text attributes.}

\item{...}{other ggplot2 parameters.}
}
\description{
Plots a histogram of the number of responses for each item and group (if specified).
Expand Down
2 changes: 1 addition & 1 deletion man/likert.matrix.plot.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{likert.matrix.plot}
\alias{likert.matrix.plot}
\title{Matrix plot (experimental)}
Expand Down
2 changes: 1 addition & 1 deletion man/mass.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{data}
\name{mass}
\alias{mass}
Expand Down
2 changes: 1 addition & 1 deletion man/pisaitems.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{data}
\name{pisaitems}
\alias{pisaitems}
Expand Down
18 changes: 9 additions & 9 deletions man/plot.likert.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{plot.likert}
\alias{plot.likert}
\title{Plots a set of likert items.}
Expand All @@ -13,24 +13,24 @@

\item{type}{the type of plot to create. Current values are bar and heat.}

\item{...}{other parameters passed passed to \code{\link{likert.bar.plot}} or
\code{\link{likert.heat.plot}}.}

\item{panel.background}{define background of the plot. See \code{\link{theme}}.}

\item{include.histogram}{if TRUE, a histogram of count of responses is also plotted.}

\item{panel.widths}{if \code{include.histogram=TRUE}, this vector of length two
specifies the ratio of the left and right panels.}

\item{legend.position}{the position for the legend ("left", "right", "bottom",
"top", or two-element numeric vector).}

\item{panel.arrange}{how panels for grouped likert items should be arrange.
Possible values are \code{v} (vertical, the default), \code{h}
(horizontal), and \code{NULL} (auto fill horizontal and vertical)}

\item{panel.strip.color}{the background color for panel labels.}

\item{legend.position}{the position for the legend ("left", "right", "bottom",
"top", or two-element numeric vector).}

\item{panel.background}{define background of the plot. See \code{\link{theme}}.}

\item{...}{other parameters passed passed to \code{\link{likert.bar.plot}} or
\code{\link{likert.heat.plot}}.}
}
\description{
This is an implementation of the S3 plot generic function. Based upon the
Expand Down
20 changes: 10 additions & 10 deletions man/plot.likert.gap.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{plot.likert.gap}
\alias{plot.likert.gap}
\title{Plots a set of likert items.}
Expand All @@ -15,30 +15,30 @@

\item{type}{the type of plot to create. Current values are bar and heat.}

\item{...}{other parameters passed passed to \code{\link{likert.bar.plot}} or
\code{\link{likert.heat.plot}}.}

\item{panel.background}{define background of the plot. See \code{\link{theme}}.}

\item{include.histogram}{if TRUE, a histogram of count of responses is also plotted.}

\item{panel.widths}{if \code{include.histogram=TRUE}, this vector of length two
specifies the ratio of the left and right panels.}

\item{legend.position}{the position for the legend ("left", "right", "bottom",
"top", or two-element numeric vector).}

\item{panel.arrange}{how panels for grouped likert items should be arrange.
Possible values are \code{v} (vertical, the default), \code{h}
(horizontal), and \code{NULL} (auto fill horizontal and vertical)}

\item{panel.strip.color}{the background color for panel labels.}

\item{legend}{title for the legend.}
\item{legend.position}{the position for the legend ("left", "right", "bottom",
"top", or two-element numeric vector).}

\item{panel.background}{define background of the plot. See \code{\link{theme}}.}

\item{satisfaction.label}{label used for satisfaction items.}

\item{importance.label}{label used for importance items.}

\item{legend}{title for the legend.}

\item{...}{other parameters passed passed to \code{\link{likert.bar.plot}} or
\code{\link{likert.heat.plot}}.}
}
\description{
This is an implementation of the S3 plot generic function. Based upon the
Expand Down
2 changes: 1 addition & 1 deletion man/print.likert.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{print.likert}
\alias{print.likert}
\title{Prints results table.}
Expand Down
2 changes: 1 addition & 1 deletion man/print.likert.bar.plot.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{print.likert.bar.plot}
\alias{print.likert.bar.plot}
\title{Print method for \code{\link{likert.bar.plot}}. The primary purpose is to
Expand Down
2 changes: 1 addition & 1 deletion man/print.likert.gap.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{print.likert.gap}
\alias{print.likert.gap}
\title{Prints results table.}
Expand Down
2 changes: 1 addition & 1 deletion man/print.likert.heat.plot.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{print.likert.heat.plot}
\alias{print.likert.heat.plot}
\title{Print method for \code{\link{likert.heat.plot}}.}
Expand Down
2 changes: 1 addition & 1 deletion man/print.xlikert.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{print.xlikert}
\alias{print.xlikert}
\title{Prints the results of \code{\link{xtable.likert}}.}
Expand Down
2 changes: 1 addition & 1 deletion man/recode.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{recode}
\alias{recode}
\title{Recode a vector.}
Expand Down
2 changes: 1 addition & 1 deletion man/reverse.levels.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{reverse.levels}
\alias{reverse.levels}
\title{Reverse the levels of a factor.}
Expand Down
2 changes: 1 addition & 1 deletion man/shinyLikert.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{shinyLikert}
\alias{shinyLikert}
\title{Shiny App for the likert package.}
Expand Down
2 changes: 1 addition & 1 deletion man/summary.likert.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{summary.likert}
\alias{summary.likert}
\title{Prints summary table of a Likert analysis.}
Expand Down
2 changes: 1 addition & 1 deletion man/summary.likert.gap.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{summary.likert.gap}
\alias{summary.likert.gap}
\title{Prints summary table of a Likert analysis.}
Expand Down
2 changes: 1 addition & 1 deletion man/xtable.likert.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{xtable.likert}
\alias{xtable.likert}
\title{Prints a LaTeX table of the likert items.}
Expand Down
2 changes: 1 addition & 1 deletion man/zeroGrob.Rd
@@ -1,4 +1,4 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{zeroGrob}
\alias{zeroGrob}
\title{The zero grob draws nothing and has zero size.}
Expand Down

0 comments on commit e9907cd

Please sign in to comment.