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

In richelbilderbeek/ormr: Work With Python Installed At A Custom Location

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(
  args,
  channel,
  ormr_folder_name,
  package_name,
  package_names,
  package_version,
  python_script_path,
  python_version,
  verbose
)

Arguments

args	arguments to a script, for example --help
channel	the channel to install Python packages from, e.g. bioconda
ormr_folder_name	can be either python3 or the name of the folder where ormr installs all Python environments and packages.
package_name	the name of one Python package
package_names	the names of one or more Python packages
package_version	a Python package's version, e.g. ==3.1, or <=2.7.1 or >=42
python_script_path	path to a Python script
python_version	the version of Python used. Use get_default_python_version to get the default Python version.
verbose	the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

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/ormr documentation built on May 23, 2022, 1:15 p.m.