default_params_doc: This function does nothing. It is intended to inherit is...
In richelbilderbeek/K3Reviews: K3 Reviews

Description Usage Arguments Note Author(s)

View source: R/default_params_doc.R

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

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

`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

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

Richèl J.C. Bilderbeek

richelbilderbeek/K3Reviews documentation built on Dec. 18, 2020, 10:40 a.m.