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

In pureseqtmr: Predict Transmembrane Protein Topology

Description

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

Usage

default_params_doc(
  download_url,
  fasta_filename,
  fasta_file_text,
  folder_name,
  protein_sequence,
  protein_sequences,
  pureseqtm_filename,
  pureseqtm_result,
  pureseqtm_url,
  temp_folder_name,
  topology,
  topology_filename,
  verbose
)

Arguments

download_url	the URL to download PureseqTM from
fasta_filename	path to a FASTA file
fasta_file_text	text of a FASTA file
folder_name	superfolder of PureseqTM. The superfolder's name is /home/[user_name]/.local/share by default, as can be obtained by get_default_pureseqtm_folder
protein_sequence	a protein sequence
protein_sequences	one or more protein sequences
pureseqtm_filename	filename to write the PureseqTM results to
pureseqtm_result	the result of a PureseqTM run
pureseqtm_url	URL of the PureseqTM git repository
temp_folder_name	path of a temporary folder. The folder does not need to exist. Files that are out in this folder are not automatically deleted, which is not a problem, as the default path given by tempdir is automatically cleaned by the operating system
topology	the topology as a tibble as returned by predict_topology
topology_filename	name of the file to save a protein's topology to
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

pureseqtmr documentation built on July 30, 2020, 5:13 p.m.