default_params_doc: This function does nothing. It is intended to inherit is...
In richelbilderbeek/iedbr: Work With IEDB

default_params_doc

R Documentation

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(
  assays,
  disease_names,
  host_organism_iris,
  max_n_queries,
  mhc_allele_name,
  mhc_allele_name_regex,
  mhc_allele_names,
  mhc_allele_names_regex,
  mhc_restriction,
  offset,
  order,
  query,
  query_results,
  select,
  source_organism_iris,
  structure_type,
  table,
  verbose
)

Arguments

`assays`	one or more assays. Possible values are "B Cell", "MHC Ligand" and "T Cell", as these are the names used at http://www.iedb.org/
`disease_names`	disease names. Possible value is "healthy"
`host_organism_iris`	the host. Possible value is "NCBITaxon:9606", which denotes Homo sapiens
`max_n_queries`	maximum number of queries. Use Inf to have no upper limit on this. Lower values are useful for debugging.
`mhc_allele_name`	name of an MHC allele
`mhc_allele_name_regex`	a regular expression for an MHC allele names
`mhc_allele_names`	names of one or more MHC allele names
`mhc_allele_names_regex`	a regular expression for a 'PostgREST' expression to select zero, one or more MHC allele names
`mhc_restriction`	MHC restriction Possible values are "Any", "Class I", "Class II", "Non-classical" and a haplotype name
`offset`	the offset of the results from a query, as checked by check_offset. A standard query uses an offset of zero and returns maximally `10000` results. To obtain the next results, an `offset` of `10000` is used.
`order`	the item by which the query is ordered, as checked by check_order. For bigger queries (i.e. with more than 10k results), `order` is important to obtain each 10k set of results in the same manner.
`query`	an IEDB query, as created by, for example, create_healthy_human_query. Use check_query to check if the `query` is valid
`query_results`	the results of a query (e.g. a call to query_iedb) as a tibble
`select`	the fields that the query returns, as checked by check_select
`source_organism_iris`	the epitope source. Possible value is "NCBITaxon:9606", which denotes Homo sapiens
`structure_type`	structure of the epitope, as checked by check_structure_type. Possible values are "Linear peptide", as these are the names used at http://www.iedb.org/
`table`	a IEDB database table, as checked by check_table
`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