default_params_doc: This function does nothing. It is intended to inherit is...

In richelbilderbeek/K3Reviews: K3 Reviews

This function does nothing. It is intended to inherit is parameters' documentation.

Description

This function does nothing. It is intended to inherit is parameters' documentation.

Usage

default_params_doc(
  formation,
  na_is_ok,
  reviewer_name,
  song_name,
  song_filenames,
  song_filename,
  verbose
)

Arguments

formation	the K3 formation, in three, alphabettically ordered uppercase characters, e.g HKM for the third formation
na_is_ok	boolean to indicate if NA is accepted
reviewer_name	name of the reviewer, e.g. Richel
song_name	name of the K3 song
song_filenames	paths to one or more song's review files
song_filename	path to a song's review file
verbose	set to TRUE for more output

Note

This is an internal function, so it should be marked with @noRd. This is not done, as this will disallow all functions to find the documentation parameters

Author(s)

Richèl J.C. Bilderbeek

richelbilderbeek/K3Reviews documentation built on July 16, 2025, 1:03 p.m.