Skip to content

Commit

Permalink
add pkgdown docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenarslan committed Mar 18, 2018
1 parent 7018d48 commit 8be1303
Show file tree
Hide file tree
Showing 113 changed files with 13,524 additions and 29 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Expand Up @@ -11,7 +11,7 @@ Authors@R: c(
email = "rubenarslan@gmail.com",
role = c("aut","cre"))
)
Version: 0.7.3
Version: 0.7.4
Depends:
R (>= 3.0.2)
Imports:
Expand Down
28 changes: 1 addition & 27 deletions LICENSE
@@ -1,27 +1 @@
formr survey framework accompanying R package
Copyright (c) 2013, Ruben C. Arslan <ruben.arslan at gmail>
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
Copyright 2013-2018, Ruben C. Arslan
7 changes: 6 additions & 1 deletion README.md
@@ -1,12 +1,17 @@
# formr
#### The accompanying R package for the survey framework [formr](https://github.com/rubenarslan/formr.org)
## The accompanying R package for the study framework [formr](https://github.com/rubenarslan/formr.org)

The formr R package provides a few convenience functions that may be useful to the users of formr ([formr.org](https://formr.org)), an online survey framework which heavily relies on R via [openCPU](https://github.com/jeroenooms/opencpu). Some functions may be useful to others too.

Some of the functions conveniently generate individual feedback graphics, some are just shorthands to make certain common operations in formr more palatable to R novices. A large number of functions help connect to formr, extract data, correctly type data (dates, numbers, text etc.), automatically aggregate items of a scale and so on.

The R package can be used inside formr.org, it is always loaded by default.

## documentation
https://rubenarslan.github.io/formr

## install

If you want to install the R package locally (e.g. to connect to formr and fetch the data in a nice format for you), run:

install.packages("devtools")
Expand Down
104 changes: 104 additions & 0 deletions docs/LICENSE-text.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

108 changes: 108 additions & 0 deletions docs/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

109 changes: 109 additions & 0 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions docs/jquery.sticky-kit.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8be1303

Please sign in to comment.