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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | 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
)
|
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 |
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 |
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
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.