From 5d01cd6f19a2de5c9a372493f39995331124e61a Mon Sep 17 00:00:00 2001 From: Marko Lalovic Date: Thu, 6 Jun 2024 21:09:24 +0200 Subject: [PATCH] minor update --- .Rbuildignore | 6 +- .gitignore | 6 +- DESCRIPTION | 6 +- README.Rmd | 12 +-- README.md | 28 +++-- cran-comments.md | 5 + docs/LICENSE-text.html | 114 --------------------- docs/articles/replicating_survey_data.html | 2 +- docs/articles/responsesR.html | 2 +- docs/articles/simulating_survey_data.html | 2 +- docs/index.html | 16 +-- docs/pkgdown.yml | 2 +- docs/reference/get_pk_var.html | 111 -------------------- docs/sitemap.xml | 15 --- 14 files changed, 49 insertions(+), 278 deletions(-) create mode 100644 cran-comments.md delete mode 100644 docs/LICENSE-text.html delete mode 100644 docs/reference/get_pk_var.html diff --git a/.Rbuildignore b/.Rbuildignore index f7d95db..46f80c5 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -16,4 +16,8 @@ ^CODE_OF_CONDUCT.md ^fix_site.py ^tests/informal$ -^dev$ \ No newline at end of file +^dev$ +^doc$ +^Meta$ +^revdep$ +^cran-comments\.md$ diff --git a/.gitignore b/.gitignore index f3e5f9b..b78026e 100644 --- a/.gitignore +++ b/.gitignore @@ -52,4 +52,8 @@ rsconnect/ # Ignore Mac DS_Store files .DS_Store **/.DS_Store -docs + +# revdep +/doc/ +/Meta/ +revdep/ diff --git a/DESCRIPTION b/DESCRIPTION index 7abd21f..922a33a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -16,9 +16,9 @@ Description: Provides an easy framework to simulate survey data commonly also allows for the estimation of parameters from existing survey data to replicate it more accurately. License: GPL-3 -URL: https://lalovic.io/responsesR, - https://github.com/markolalovic/responsesR -BugReports: https://github.com/markolalovic/responsesR/issues +URL: https://lalovic.io/responsesR/, + https://github.com/markolalovic/responsesR/ +BugReports: https://github.com/markolalovic/responsesR/issues/ Depends: R (>= 3.3) Imports: diff --git a/README.Rmd b/README.Rmd index 70b424a..041f27a 100644 --- a/README.Rmd +++ b/README.Rmd @@ -12,10 +12,10 @@ knitr::opts_chunk$set( ## responsesR: simulate Likert item responses in R Package logo -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![codecov](https://codecov.io/gh/markolalovic/responsesR/graph/badge.svg?token=HZTG6RUB2J)](https://codecov.io/gh/markolalovic/responsesR) [![R-CMD-check](https://github.com/markolalovic/responsesR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/markolalovic/responsesR/actions/workflows/R-CMD-check.yaml) +[![codecov](https://codecov.io/gh/markolalovic/responsesR/graph/badge.svg?token=HZTG6RUB2J)](https://codecov.io/gh/markolalovic/responsesR) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10889981.svg)](https://doi.org/10.5281/zenodo.10889981) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) This package provides an easy framework to simulate survey data commonly analyzed in applied social research, specifically Likert items. Users can specify latent variables by providing means, standard deviations, and optionally, skewness and correlations. The generated data set represents responses to Likert scale questions, which can be used for various purposes, such as validating theoretical findings obtained through factor analysis and structural equation modeling. The package also allows for the estimation of parameters from existing survey data to replicate it more accurately. @@ -317,12 +317,12 @@ knitr::include_graphics("./man/figures/articles/agreeableness_grouped_boxplot.sv ``` ## Dependency statement -To maintain a lightweight package, responsesR only imports [mvtnorm](https://cran.r-project.org/web/packages/mvtnorm/index.html), along with the standard R packages stats and graphics, which are typically included in R releases. An additional suggested dependency is the package [sn](https://cran.r-project.org/web/packages/sn/index.html), necessary only for generating random responses from correlated Likert items with multivariate skew normal latent distribution. However, the package prompts the user to install this dependency during interactive sessions. +To maintain a lightweight package, responsesR only imports [mvtnorm](https://cran.r-project.org/package=mvtnorm), along with the standard R packages stats and graphics, which are typically included in R releases. An additional suggested dependency is the [package sn](https://cran.r-project.org/package=sn), necessary only for generating random responses from correlated Likert items with multivariate skew normal latent distribution. However, the package prompts the user to install this dependency during interactive sessions. ## Further reading -* [Get started](https://markolalovic.github.io/responsesR/articles/responsesR.html) -* [Functions reference documentation](https://markolalovic.github.io/responsesR/reference/index.html) -* [Introduction to responsesR package](https://markolalovic.github.io/responsesR/articles/introduction_to_responsesR.html) +* [Get started](https://lalovic.io/responsesR/articles/responsesR.html) +* [Functions reference documentation](https://lalovic.io/responsesR/reference/index.html) +* [Introduction to responsesR package](https://lalovic.io/responsesR/articles/introduction_to_responsesR.html) ## Contributions Feel free to create issues for bugs or suggestions on the [issues page](https://github.com/markolalovic/responsesR/issues). diff --git a/README.md b/README.md index fe7eca0..6b03673 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@ -[![License: -MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![codecov](https://codecov.io/gh/markolalovic/responsesR/graph/badge.svg?token=HZTG6RUB2J)](https://codecov.io/gh/markolalovic/responsesR) [![R-CMD-check](https://github.com/markolalovic/responsesR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/markolalovic/responsesR/actions/workflows/R-CMD-check.yaml) +[![codecov](https://codecov.io/gh/markolalovic/responsesR/graph/badge.svg?token=HZTG6RUB2J)](https://codecov.io/gh/markolalovic/responsesR) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10889981.svg)](https://doi.org/10.5281/zenodo.10889981) +[![License: GPL +v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) This package provides an easy framework to simulate survey data commonly @@ -525,23 +525,21 @@ plot_grid(p1, p2, nrow = 2) ## Dependency statement To maintain a lightweight package, responsesR only imports -[mvtnorm](https://cran.r-project.org/web/packages/mvtnorm/index.html), -along with the standard R packages stats and graphics, which are -typically included in R releases. An additional suggested dependency is -the package [sn](https://cran.r-project.org/web/packages/sn/index.html), -necessary only for generating random responses from correlated Likert -items with multivariate skew normal latent distribution. However, the -package prompts the user to install this dependency during interactive -sessions. +[mvtnorm](https://cran.r-project.org/package=mvtnorm), along with the +standard R packages stats and graphics, which are typically included in +R releases. An additional suggested dependency is the [package +sn](https://cran.r-project.org/package=sn), necessary only for +generating random responses from correlated Likert items with +multivariate skew normal latent distribution. However, the package +prompts the user to install this dependency during interactive sessions. ## Further reading -- [Get - started](https://markolalovic.github.io/responsesR/articles/responsesR.html) +- [Get started](https://lalovic.io/responsesR/articles/responsesR.html) - [Functions reference - documentation](https://markolalovic.github.io/responsesR/reference/index.html) + documentation](https://lalovic.io/responsesR/reference/index.html) - [Introduction to responsesR - package](https://markolalovic.github.io/responsesR/articles/introduction_to_responsesR.html) + package](https://lalovic.io/responsesR/articles/introduction_to_responsesR.html) ## Contributions diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 0000000..858617d --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,5 @@ +## R CMD check results + +0 errors | 0 warnings | 1 note + +* This is a new release. diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html deleted file mode 100644 index eeb1ef5..0000000 --- a/docs/LICENSE-text.html +++ /dev/null @@ -1,114 +0,0 @@ - -License • responsesR - - -
-
- - - -
-
-
-

License

-
- -
MIT License
-
-Copyright (c) 2024 Marko Lalovic
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
- -
- - - -
- - - -
- - - - - - - - diff --git a/docs/articles/replicating_survey_data.html b/docs/articles/replicating_survey_data.html index d18bfbf..976ce52 100644 --- a/docs/articles/replicating_survey_data.html +++ b/docs/articles/replicating_survey_data.html @@ -105,7 +105,7 @@

Last Updated: 2024-06-06

-library(responsesR) # load responsesR
+library(responsesR) # load responsesR
 library(psych) # for the bfi data set
 
 # optionally, to recreate the plots:
diff --git a/docs/articles/responsesR.html b/docs/articles/responsesR.html
index 2d9442f..e495aa9 100644
--- a/docs/articles/responsesR.html
+++ b/docs/articles/responsesR.html
@@ -130,7 +130,7 @@ 
Generating random item responses
-library(responsesR) 
+library(responsesR) 
 set.seed(12345)

To generate n = 10 responses with K = 5 response categories (on a 5-point Likert scale), use:

diff --git a/docs/articles/simulating_survey_data.html b/docs/articles/simulating_survey_data.html index 80f9714..f49b0e1 100644 --- a/docs/articles/simulating_survey_data.html +++ b/docs/articles/simulating_survey_data.html @@ -106,7 +106,7 @@

Last Updated: 2024-06-06

 # load responsesR
-library(responsesR)
+library(responsesR)
 
 # optionally, to recreate the plots:
 library(RColorBrewer)
diff --git a/docs/index.html b/docs/index.html
index 8abca3a..9e288a9 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -119,7 +119,7 @@ 
Simulating survey data
 
Suppose that on average participants in Course A had a neutral experience, while those in Course B had a more positive experience. By choosing appropriate parameters for the latent variables and setting the number of categories (to K = 4 in this example), we can generate hypothetical responses (standard deviation sd = 1 and skewness gamma1 = 0, by default):

 
-library(responsesR) # load the package
+library(responsesR) # load the package
 set.seed(12345) # to ensure reproducible results
 
 course_A <- get_responses(n = 10, mu = 0, K = 4)
@@ -523,15 +523,15 @@ 
Replicating survey data
 
Dependency statement
 

-
To maintain a lightweight package, responsesR only imports mvtnorm, along with the standard R packages stats and graphics, which are typically included in R releases. An additional suggested dependency is the package sn, necessary only for generating random responses from correlated Likert items with multivariate skew normal latent distribution. However, the package prompts the user to install this dependency during interactive sessions.

+
To maintain a lightweight package, responsesR only imports mvtnorm, along with the standard R packages stats and graphics, which are typically included in R releases. An additional suggested dependency is the package sn, necessary only for generating random responses from correlated Likert items with multivariate skew normal latent distribution. However, the package prompts the user to install this dependency during interactive sessions.

 

 

 
Further reading
 

 
 

 

@@ -548,7 +548,7 @@ 
Contributions
 
  • Browse source code
    • 
-
  • Report a bug
    • 
+
  • Report a bug
    • 
 
 
    
 
@@ -584,10 +584,10 @@ 
    Developers
    
 
    
 
    Dev status
    
 
      
-
    • License: MIT
      • 
-
    • codecov
      • 
 
    • R-CMD-check
      • 
+
    • codecov
      • 
 
    • DOI
      • 
+
    • License: GPL v3
      • 
 
    
 
    
 
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index f3acc1b..861022b 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -6,7 +6,7 @@ articles:
   replicating_survey_data: replicating_survey_data.html
   responsesR: responsesR.html
   simulating_survey_data: simulating_survey_data.html
-last_built: 2024-06-06T18:18Z
+last_built: 2024-06-06T19:02Z
 urls:
   reference: https://markolalovic.github.io/responsesR/reference
   article: https://markolalovic.github.io/responsesR/articles
diff --git a/docs/reference/get_pk_var.html b/docs/reference/get_pk_var.html
deleted file mode 100644
index a7f1ac6..0000000
--- a/docs/reference/get_pk_var.html
+++ /dev/null
@@ -1,111 +0,0 @@
-
-Calculate variance of probabilities `pk` — get_pk_var • responsesR
-    
-
-    
    
-      
    
-
-      
-
-      
    
-  
    
-    
    
-    
    Calculate variance of probabilities `pk`
    
-    Source: R/helper_functions.R
-    
-    
    
-
-    
    
-    
    Calculate variance of probabilities `pk`
    
-    
    
-
-    
    
-    
    get_pk_var(pk)
    
-    
    
-
-    
    
-    
    Arguments
    
-    
    pk
    
-
    vector of probabilities
    
-
-
    
-    
    
-    
    Value
    
-    
-
-
    variance of `pk`
    
-    
    
-
-  
    
-  
-
    
-
-
-      
    
-
-  
-
-
-  
-
-  
-
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
index 913b64a..e04f04f 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -6,18 +6,6 @@
   
     https://markolalovic.github.io/responsesR/CODE_OF_CONDUCT.html
   
-  
-    https://markolalovic.github.io/responsesR/LICENSE-text.html
-  
-  
-    https://markolalovic.github.io/responsesR/articles/articles/introduction_to_responsesR.html
-  
-  
-    https://markolalovic.github.io/responsesR/articles/articles/replicating_survey_data.html
-  
-  
-    https://markolalovic.github.io/responsesR/articles/articles/simulating_survey_data.html
-  
   
     https://markolalovic.github.io/responsesR/articles/index.html
   
@@ -72,9 +60,6 @@
   
     https://markolalovic.github.io/responsesR/reference/get_pk_mean.html
   
-  
-    https://markolalovic.github.io/responsesR/reference/get_pk_var.html
-  
   
     https://markolalovic.github.io/responsesR/reference/get_prop_table.html