diff --git a/.Rbuildignore b/.Rbuildignore index 01993b8592e328f86fc7e3b9fa5d9067eb85da3f..3d04812f583674e904cd78399ae8a9fe5d55e685 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,3 +3,4 @@ ^.*\.Rproj$ ^\.Rproj.user$ ^LICENSE\.md$ +^README\.Rmd$ diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000000000000000000000000000000000000..7023fe870ca6c59e0a7dec92494c3d8e92711dba --- /dev/null +++ b/README.Rmd @@ -0,0 +1,66 @@ +--- +output: github_document +--- + +<!-- README.md is generated from README.Rmd. Please edit that file --> + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>", + fig.path = "man/figures/README-", + out.width = "100%" +) +``` + +# choiceTools + +<!-- badges: start --> + +<!-- badges: end --> + +The package contains some files that may make your live as a choice modeller easier, especially if you use the r package `apollo`. + +It contains the following functions: + +- createSets: If you have a new dataset and want to understand how many people chose which alternative or want to get an overview of your choice sets, this function helps you. It creates a list in which each element is a choice set showing its alternatives with attributes and the frequencies and percentage values of chosen alternatives for each alternative. + +- poetest: Conduct the test by Poe et al. (2005) with ease when you want to compare willingness to pay values from two models estimated with apollo + +- apollo_ztest: Conduct a z test for all parameters between two models estimated with apollo in one line + +- quicktexregapollo: If you want to create publication-ready tables with texreg, this function transform an apollo object into a texreg object + +- subcoef and remGOF: make it easy to split your model parameters so that you can create publication-ready tables where columns represent different sets of estimated parameters from one model rather than all parameters in one row. + +## Installation + + +You can install the stable version of choiceTools like so: + +``` r +devtools::install_git('https://git.idiv.de/dj44vuri/choicetools') +``` + + +You can install the development version of choiceTools like so: + +``` r +devtools::install_git('https://git.idiv.de/dj44vuri/choicetools', ref = "devel" ) +``` + +## Example + +This is a basic example which shows you how to solve a common problem: + +```{r example} +library(choiceTools) +## basic example code +``` + + + +You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this. + + + diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..d43d0a130933d18bea7eb5d2a5bf102236eef65a --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ + +<!-- README.md is generated from README.Rmd. Please edit that file --> + +# choiceTools + +<!-- badges: start --> +<!-- badges: end --> + +The package contains some files that may make your live as a choice +modeller easier, especially if you use the r package `apollo`. + +It contains the following functions: + +- createSets: If you have a new dataset and want to understand how many + people chose which alternative or want to get an overview of your + choice sets, this function helps you. It creates a list in which each + element is a choice set showing its alternatives with attributes and + the frequencies and percentage values of chosen alternatives for each + alternative. + +- poetest: Conduct the test by Poe et al. (2005) with ease when you want + to compare willingness to pay values from two models estimated with + apollo + +- apollo_ztest: Conduct a z test for all parameters between two models + estimated with apollo in one line + +- quicktexregapollo: If you want to create publication-ready tables with + texreg, this function transform an apollo object into a texreg object + +- subcoef and remGOF: make it easy to split your model parameters so + that you can create publication-ready tables where columns represent + different sets of estimated parameters from one model rather than all + parameters in one row. + +## Installation + +You can install the stable version of choiceTools like so: + +``` r +devtools::install_git('https://git.idiv.de/dj44vuri/choicetools') +``` + +You can install the development version of choiceTools like so: + +``` r +devtools::install_git('https://git.idiv.de/dj44vuri/choicetools', ref = "devel" ) +``` + +## Example + +This is a basic example which shows you how to solve a common problem: + +``` r +library(choiceTools) +## basic example code +``` + +You’ll still need to render `README.Rmd` regularly, to keep `README.md` +up-to-date. `devtools::build_readme()` is handy for this.