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

In richelbilderbeek/ncbi: Does Stuff

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(
  chunk_size,
  fasta_file,
  fasta_text,
  gene_ids,
  gene_name,
  hgvs,
  protein_id,
  protein_ids,
  pureseqtm_folder_name,
  s,
  snp_id,
  subject_ids,
  temp_fasta_filename,
  variation,
  variations,
  verbose
)

Arguments

chunk_size	the number of protein IDs in an NCBI quey. Too many values results in an NCBI API error
fasta_file	name of a FASTA file
fasta_text	text in the same format as a FASTA file
gene_ids	one or more IDs of a gene
gene_name	name of a gene
hgvs	a variation in HGVS ('Human Genome Variation Society') format
protein_id	ID of a protein. For example, NP_001007554.1 is a protein ID.
protein_ids	one or more protein IDs. For example, NP_001007554.1 is a protein ID.
pureseqtm_folder_name	PureseqTM folder name, as can be obtained by get_default_pureseqtm_folder.
s	string in HVGS format to be parsed, for example, NP_000585.2:p.Gly144Asp
snp_id	the ID of a SNP
subject_ids	one of more IDs of a subject
temp_fasta_filename	name for a temporary FASTA file
variation	one variation. For example, NP_009089.4:p.Val723Gly is a variation.
variations	one or more variations. For example, NP_009089.4:p.Val723Gly is a variation.
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/ncbi documentation built on July 9, 2023, 3:51 a.m.