strohne / volker

Volker Package

Aye 👋

I'm sailing the data seas ⛵. My home ports are Greifswald, Münster, Mainz, and the Datavana.

volker's Issues

Implement limits in plots

We have a limits parameter in metric plot function. It does nothin yet.

Overview about parameteres

In the documentation (intro vignette?) show a table with all plot and tab functions in rows, all parameters in cols and x when a function supports the parameter.

Always report missings in the base

Currently, some functions (for counts) provide a missings parameter. Others just skip missings. Suggestion:

• Always report missings in the plot subtitle, a table footer or print a warning
• For table functions, add a missings column (that is not included in the calculation of totals or percentages)
• The missings parameter should be FALSE by default. When set to TRUE, missings should be treated as normal values, included in plots and tables as normal categories.

Create pkgdown help pages

https://pkgdown.r-lib.org/

Keep levels even if a column was converted to character

See "Replace item labels" test in test-labels.R

RChecks: no visible binding for global variable

RChecks: no visible binding for global variable

The .data pronoun does not work in select or rename...tidyselect does not like it.

Implement report_metrics and report_counts

Implement report_metrics and report_counts

Order of items and factor levels

In all plots and tables, keep item, value and factor order.

Warn if the data contains only NAs

Check whether a column contains only NA values and output a warning (by now, it fails with cryptic messages)

Getting started

Add a simple getting started section to the readme

Always put -2 / Weiß nicht to the right

In frequency plots, the value order may be changed (-1, +1). Keep the residual categories with negative values always as last category.

Markdown template

Add a markdown template with sensible defaults for creating reports:

• Knit options echo=F, include=T
• Load packages: tidyverse and volker
• Sections: Load data, prepare data, report

Plot height: calculate differently if a plot has a caption

In reports, respect the title in plot height calculation

Title and base for tables

Implement table titles and a base row

Add examples to the function help

Add examples to the function help

Numbers for metric plots: Output the mean?

Numbers for metric plots: Output the mean?

Release volker 1.0.0

First release:

• usethis::use_cran_comments()
• Update (aspirational) install instructions in README
• Proofread Title: and Description:
• Check that all exported functions have @return and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• git pull
• Check if any deprecation processes should be advanced, as described in Gradual deprecation
• urlchecker::url_check()
• devtools::build_readme()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• git push
• Draft blog post

Submit to CRAN:

• usethis::use_version('major')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• Add preemptive link to blog post in pkgdown news menu
• usethis::use_github_release()
• usethis::use_dev_version(push = TRUE)
• Finish blog post
• Tweet

Revise examples in readme

For the readme: Create better tables and maybe plots, revise the layout. Can be directly created inside the README.Rmd

Check input scales

First: use cli package to generate nice colorful messages in the check functions.
Second: For all plot / count functions, check whether the scale of the input vars is as expected (e.g. metric for a metric table) and prunt appropriate warnings.

Percentages

Can we print interactive tables to switch between column, row or total shares?

Build: Plots render differently on different machines

Remove plot / report tests from build?

Or tweak settings: rstudio/rstudio#7028

Implement category-parameter

Implement category-parameter in plot_counts_one() as in all other plots methods for categorical data

Add help file for Sosci API integration

Tutorial: show how to quickly analyze Sosci Survey data

Remove missings from tables

Default parameter in descriptive tables should be: no missings. Can the number of missings be printed below the table?

Implement missing table and plot functions

We still need three basic functions to fill the gap of the scheme:

• tab_counts_items_grouped
• plot_counts_items_grouped
• tab_counts_items_cor

And two plot functions for correlations

• plot_metrics_items_cor
• plot_counts_items_cor

Tests: Compare tibbles, not only printed output

In test-labels.R, consider testing the data frames, not the printing result.

RChecks

Fix all RCheck issues

Plot height in markdowns

Plot height is only calculated when using the report function. Implement a plot function for vlkr_plots that calculate and render the target height for other functions.

Item order

Die Reihenfolge der Items kommt durcheinander:

ds <- tribble(
  ~f1, ~f2, ~f10,
  1,     1,    1,
  1,     2,    1,
  2,     2,    2
) 

plot_counts(ds, c(f1:f10))
tab_counts(ds, c(f1:f10))

Bei metrics klappt es:

plot_metrics(ds, c(f1:f10))
tab_metrics(ds, c(f1:f10))

Außerdem ist hier das Farbschema unschön. Besser differenzieren:

• bei nur zwei Werten türkis statt schwarz nehmen.
• bei x Werten dann schwarz dazu nehmen