fetch_alphafold_prediction: Fetch AlphaFold prediction

Description Usage Arguments Value Examples

View source: R/fetch_alphafold_prediction.R

Description

Fetches atom level data for AlphaFold predictions either for selected proteins or whole organisms.

Usage

1
2
3
4
5
6
7
fetch_alphafold_prediction(
  uniprot_ids = NULL,
  organism_name = NULL,
  timeout = 3600,
  return_data_frame = FALSE,
  show_progress = TRUE
)

Arguments

uniprot_ids

optional, a character vector of UniProt identifiers for which predictions should be fetched. This argument is mutually exclusive to the organism_name argument.

organism_name

optional, a character value providing the name of an organism for which all available AlphaFold predictions should be retreived. The name should be the capitalised scientific species name (e.g. "Homo sapiens"). Note: Some organisms contain a lot of predictions which might take a considerable amount of time and memory to fetch. Therefore, you should be sure that your system can handle fetching predictions for these organisms. This argument is mutually exclusive to the uniprot_ids argument.

timeout

a numeric value specifying the time in seconds until the download of an organism archive times out. The default is 3600 seconds.

return_data_frame

a logical value that specifies if true, a data frame instead of a list is returned. It is recommended to only use this if not many pdb structures are retrieved. Default is FALSE.

show_progress

a logical value that specifies if true, a progress bar will be shown. Default is TRUE.

Value

A list that contains atom level data for AlphaFold predictions. If return_data_frame is TRUE, a data frame with this information is returned instead. The data frame contains the following columns:

Examples

1
2
3
4
5
6
alphafold <- fetch_alphafold_prediction(
  uniprot_ids = c("F4HVG8", "O15552"),
  return_data_frame = TRUE
)

head(alphafold, n = 10)

protti documentation built on Sept. 17, 2021, 5:12 p.m.