Package 'restez'

Description

This function is called whenever sequence files have been successfully added to the nucleotide SQL database. Row entries are added to 'add_lot.tsv' in the user's restez path containing the filename, GB release numbers and the time of successful adding. The log is to help users keep track of when sequences have been added.

Usage

add_rcrd_log(fl)

Arguments

See Also

Other private: cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Helper function for printing lines to console. Automatically formats lines by adding newlines.

Usage

cat_line(...)

Arguments

See Also

Other private: add_rcrd_log(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Print to console green text to indicate a name/filepath/text

Usage

char(x)

Arguments

Value

coloured character encoding, character

See Also

Other private: add_rcrd_log(), cat_line(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

All retrieval functions need a stable internet connection to work properly. This internal function pings the google homepage and throws an error if it cannot be reached.

Usage

check_connection()

Author(s)

Hajk-Georg Drost

See Also

Other private: add_rcrd_log(), cat_line(), char(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Removes all temporary test data created.

Usage

cleanup()

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Returns TRUE if a restez SQL database has been connected.

Usage

connected()

Value

Logical

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Safely acquire the restez connection. Raises error if no connection set.

Usage

connection_get()

Value

connection

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return the number of ids in a user's restez database.

Usage

count_db_ids(db = "nucleotide")

Arguments

Details

Requires an open connection. If no connection or db 0 is returned.

Value

integer

See Also

Other database: db_create(), db_delete(), db_download(), demo_db_create(), is_in_db(), list_db_ids()

Examples

library(restez)
restez_path_set(filepath = tempdir())
demo_db_create(n = 5)
(count_db_ids())

# delete demo after example
db_delete(everything = TRUE)

Description

Create a new local SQL database from downloaded files. Currently only GenBank/nucleotide/nuccore database is supported.

Usage

db_create(
  db_type = "nucleotide",
  min_length = 0,
  max_length = NULL,
  acc_filter = NULL,
  invert = FALSE,
  alt_restez_path = NULL,
  scan = FALSE
)

Arguments

Details

All .seq.gz files are added to the database by default. A user can specify minimum/maximum sequence lengths or accession numbers to limit the sequences to be added to the database – smaller databases are faster to search. The final selection of sequences is the result of applying all filters (acc_filter, min_length, max_length) in combination.

The scan option can decrease the time needed to build a database if only a small number of sequences should be written to the database compared to the number of the sequences downloaded from GenBank; i.e., if many of the files downloaded from GenBank do not contain any sequences that should be written to the database. When set to TRUE, if a file does not contain any of the accessions in acc_filter, further processing of that file will be skipped and none of the sequences it contains will be added to the database.

Alternatively, a user can use the alt_restez_path to add the files from an alternative restez file path. For example, you may wish to have a database of all environmental sequences but then an additional smaller one of just the sequences with lengths below 100 bp. Instead of having to download all environmental sequences twice, you can generate multiple restez databases using the same downloaded files from a single restez path.

This function will not overwrite a pre-existing database. Old databases must be deleted before a new one can be created. Use db_delete() with everything=FALSE to delete an SQL database.

Connections/disconnections to the database are made automatically.

See Also

Other database: count_db_ids(), db_delete(), db_download(), demo_db_create(), is_in_db(), list_db_ids()

Examples

## Not run: 
# Example of general usage
library(restez)
restez_path_set(filepath = 'path/for/downloads/and/database')
db_download()
db_create()

# Example of using `acc_filter`
#
# Download files to temporary directory
temp_dir <- paste0(tempdir(), "/restez", collapse = "")
dir.create(temp_dir)
restez_path_set(filepath = temp_dir)
# Choose GenBank domain 20 ('unannotated'), the smallest
db_download(preselection = 20)
# Only include three accessions in database
db_create(
  acc_filter = c("AF000122", "AF000123", "AF000124")
)
list_db_ids()
db_delete()
unlink(temp_dir)

## End(Not run)

Description

Delete the local SQL database and/or restez folder.

Usage

db_delete(everything = FALSE)

Arguments

Details

Any connected database will be automatically disconnected.

See Also

Other database: count_db_ids(), db_create(), db_download(), demo_db_create(), is_in_db(), list_db_ids()

Examples

library(restez)
fp <- tempdir()
restez_path_set(filepath = fp)
demo_db_create(n = 10)
db_delete(everything = FALSE)
# Will not run: gb_sequence_get(id = 'demo_1')
# only the SQL database is deleted
db_delete(everything = TRUE)
# Now returns NULL
(restez_path_get())

Description

Download .seq.tar files from the latest GenBank release.

Usage

db_download(
  db = "nucleotide",
  overwrite = FALSE,
  preselection = NULL,
  max_tries = 1
)

Arguments

Details

In default mode, the user interactively selects the parts (i.e., "domains") of GenBank to download (e.g. primates, plants, bacteria ...). Alternatively, the selected domains can be provided as a character string to preselection.

The max_tries argument is useful for large databases that may otherwise fail due to periodic lapses in internet connectivity. This value can be set to Inf to continuously try until the database download succeeds (not recommended if you do not have an internet connection!).

Value

T/F, if all files download correctly, TRUE else FALSE.

See Also

ncbi_acc_get()

Other database: count_db_ids(), db_create(), db_delete(), demo_db_create(), is_in_db(), list_db_ids()

Examples

## Not run: 
library(restez)
restez_path_set(filepath = 'path/for/downloads')
db_download()

## End(Not run)

Description

Download .seq.tar files from the latest GenBank release. The user interactively selects the parts of GenBank to download (e.g. primates, plants, bacteria ...). This is an internal function so the download can be wrapped in ⁠while()⁠ to enable persistent downloading.

Usage

db_download_intern(db = "nucleotide", overwrite = FALSE, preselection = NULL)

Arguments

Details

The downloaded files will appear in the restez filepath under downloads.

Value

T/F, if all files download correctly, TRUE else FALSE.

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Returns the maximum and minimum sequence lengths as set by the user upon db creation.

Usage

db_sqlngths_get()

Details

If no file found, returns empty character vector.

Value

vector of integers

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Log the min and maximum sequence length used in the created db.

Usage

db_sqlngths_log(min_lngth, max_lngth)

Arguments

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Creates a local mock SQL database from package test data for demonstration purposes. No internet connection required.

Usage

demo_db_create(db_type = "nucleotide", n = 100)

Arguments

See Also

Other database: count_db_ids(), db_create(), db_delete(), db_download(), is_in_db(), list_db_ids()

Examples

library(restez)
# set the restez path to a temporary dir
restez_path_set(filepath = tempdir())
# create demo database
demo_db_create(n = 5)
# in the demo, IDs are 'demo_1', 'demo_2' ...
(gb_sequence_get(id = 'demo_1'))

# Delete a demo database after an example
db_delete(everything = TRUE)

Description

Returns the size of directory in GB

Usage

dir_size(fp)

Arguments

Value

numeric

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return path to folder where raw .seq files are stored.

Usage

dwnld_path_get()

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

This function is called whenever a file is successfully downloaded. A row entry is added to the 'download_log.tsv' in the user's restez path containing the file name, the GB release number and the time of successfully download. The log is to help users keep track of when they downloaded files and to determine if the downloaded files are out of date.

Usage

dwnld_rcrd_log(fl)

Arguments

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return fasta format as expected from an Entrez call. If not all IDs are returned, will run rentrez::entrez_fetch.

Usage

entrez_fasta_get(id, ...)

Arguments

Value

character string containing the file created

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Wrapper for rentrez::entrez_fetch.

Usage

entrez_fetch(db, id = NULL, rettype, retmode = "", ...)

Arguments

Details

Attempts to first search local database with user-specified parameters, if the record is missing in the database, the function then calls rentrez::entrez_fetch to search GenBank remotely.

rettype='fasta' and rettype='gb' are respectively equivalent to gb_fasta_get() and gb_record_get().

Value

character string containing the file created

Supported return types and modes

XML retmode is not supported. Rettypes 'seqid', 'ft', 'acc' and 'uilist' are also not supported.

Note

It is advisable to call restez and rentrez functions with '::' notation rather than library() calls to avoid namespace issues. e.g. restez::entrez_fetch().

See Also

rentrez::entrez_fetch()

Examples

library(restez)
restez_path_set(tempdir())
demo_db_create(n = 5)
# return fasta record
fasta_res <- entrez_fetch(db = 'nucleotide',
                          id = c('demo_1', 'demo_2'),
                          rettype = 'fasta')
cat(fasta_res)
# return whole GB record in text format
gb_res <- entrez_fetch(db = 'nucleotide',
                       id = c('demo_1', 'demo_2'),
                       rettype = 'gb')
cat(gb_res)
# NOT RUN
# whereas these request would go through rentrez
# fasta_res <- entrez_fetch(db = 'nucleotide',
#                           id = c('S71333', 'S71334'),
#                           rettype = 'fasta')
# gb_res <- entrez_fetch(db = 'nucleotide',
#                        id = c('S71333', 'S71334'),
#                        rettype = 'gb')

# delete demo after example
db_delete(everything = TRUE)

Description

Return gb and gbwithparts format as expected from an Entrez call. If not all IDs are returned, will run rentrez::entrez_fetch.

Usage

entrez_gb_get(id, ...)

Arguments

Value

character string containing the file created

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return accession ID from GenBank record

Usage

extract_accession(record)

Arguments

Details

If element is not found, ” returned.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Search through GenBank record for a keyword and return text up to the end_pattern.

Usage

extract_by_patterns(record, start_pattern, end_pattern = "\n")

Arguments

Details

The start_pattern should be any of the capitalized elements in a GenBank record (e.g. LOCUS, DESCRIPTION, ACCESSION). The end_pattern depends on how much of the selected element a user wants returned. By default, the extraction will stop at the next newline. If keyword or end pattern not found, returns NULL.

Value

character or NULL

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return clean sequence from seqrecpart of a GenBank record

Usage

extract_clean_sequence(seqrecpart, max_len = 1e+08)

Arguments

Details

If element is not found, ” returned.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return definition from GenBank record.

Usage

extract_definition(record)

Arguments

Details

If element is not found, ” returned.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return feature table as list from GenBank record

Usage

extract_features(record)

Arguments

Details

If element is not found, empty list returned.

Value

list of lists

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return information part from GenBank record

Usage

extract_inforecpart(record)

Arguments

Details

If element is not found, ” returned.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return keywords as list from GenBank record

Usage

extract_keywords(record)

Arguments

Details

If element is not found, ” returned.

Value

character vector

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return locus information from GenBank record

Usage

extract_locus(record)

Arguments

Details

If element is not found, ” returned.

Value

named character vector

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return organism name from GenBank record

Usage

extract_organism(record)

Arguments

Details

If element is not found, ” returned.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return sequence part from GenBank record

Usage

extract_seqrecpart(record)

Arguments

Details

If element is not found, ” returned.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return sequence from GenBank record

Usage

extract_sequence(record)

Arguments

Details

If element is not found, ” returned.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return accession + version ID from GenBank record

Usage

extract_version(record)

Arguments

Details

If element is not found, ” returned.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Download a GenBank .seq.tar file. Check the file has downloaded properly. If not, returns FALSE. If overwrite is true, any previous file will be overwritten.

Usage

file_download(fl, overwrite = FALSE)

Arguments

Value

T/F

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Record a filename in a log file along with GB release and time.

Usage

filename_log(fl, fp)

Arguments

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Read records from a .seq file.

Usage

flatfile_read(flpth)

Arguments

Value

list of GenBank records in text format

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Given a list of seq_files, read and add the contents of the files to a SQL-like database. If any errors during the process, FALSE is returned.

Usage

gb_build(
  dpth,
  seq_files,
  max_length,
  min_length,
  acc_filter = NULL,
  invert = FALSE,
  scan = FALSE
)

Arguments

Details

This function will automatically connect to the restez database.

Value

Logical

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return the definition line for an accession ID.

Usage

gb_definition_get(id)

Arguments

Value

named vector of definitions, if no results found NULL

See Also

ncbi_acc_get()

Other get: gb_fasta_get(), gb_organism_get(), gb_record_get(), gb_sequence_get(), gb_version_get()

Examples

library(restez)
restez_path_set(filepath = tempdir())
demo_db_create(n = 5)
(def <- gb_definition_get(id = 'demo_1'))
(defs <- gb_definition_get(id = c('demo_1', 'demo_2')))


# delete demo after example
db_delete(everything = TRUE)

Description

Make data.frame from columns vectors for nucleotide entries. As part of gb_df_generate().

Usage

gb_df_create(accessions, versions, organisms, definitions, sequences, records)

Arguments

Value

data.frame

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

For a list of records, construct a data.frame for insertion into SQL database.

Usage

gb_df_generate(
  records,
  min_length = 0,
  max_length = NULL,
  acc_filter = NULL,
  invert = FALSE
)

Arguments

Details

The resulting data.frame has five columns: accession, organism, raw_definition, raw_sequence, raw_record. The prefix 'raw_' indicates the data has been converted to the raw format, see ?charToRaw, in order to save on RAM. The raw_record contains the entire GenBank record in text format.

Use acc_filter and max and min sequence lengths to minimize the size of the database. All sequences have to be at least as long as min and less than or equal in length to max, unless max is NULL in which there is no maximum length. The final selection of sequences is the result of applying all filters (acc_filter, min_length, max_length) in combination.

Value

data.frame, or NULL if no records pass filters

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return elements of GenBank record e.g. sequence, definition ...

Usage

gb_extract(
  record,
  what = c("accession", "version", "organism", "sequence", "definition", "locus",
    "features", "keywords")
)

Arguments

Details

This function uses a REGEX to extract particular elements of a GenBank record. All of the what options return a single character with the exception of 'locus' or 'keywords' that return character vectors and 'features' that returns a list of lists for all features.

The accuracy of these functions cannot be guaranteed due to the enormity of the GenBank database. But the function is regularly tested on a range of GenBank records.

Note: all non-latin1 characters are converted to '-'.

Value

character or list of lists (what='features') or named character vector (what='locus')

Examples

library(restez)
data('record')
(gb_extract(record = record, what = 'locus'))

Description

Get sequence and definition data in FASTA format. Equivalent to rettype='fasta' in rentrez::entrez_fetch().

Usage

gb_fasta_get(id, width = 70)

Arguments

Value

named vector of fasta sequences, if no results found NULL

See Also

ncbi_acc_get()

Other get: gb_definition_get(), gb_organism_get(), gb_record_get(), gb_sequence_get(), gb_version_get()

Examples

library(restez)
restez_path_set(filepath = tempdir())
demo_db_create(n = 5)
(fasta <- gb_fasta_get(id = 'demo_1'))
(fastas <- gb_fasta_get(id = c('demo_1', 'demo_2')))


# delete demo after example
db_delete(everything = TRUE)

Description

Return the organism name for an accession ID.

Usage

gb_organism_get(id)

Arguments

Value

named vector of definitions, if no results found NULL

See Also

ncbi_acc_get()

Other get: gb_definition_get(), gb_fasta_get(), gb_record_get(), gb_sequence_get(), gb_version_get()

Examples

library(restez)
restez_path_set(filepath = tempdir())
demo_db_create(n = 5)
(org <- gb_organism_get(id = 'demo_1'))
(orgs <- gb_organism_get(id = c('demo_1', 'demo_2')))


# delete demo after example
db_delete(everything = TRUE)

Description

Return the entire GenBank record for an accession ID. Equivalent to rettype='gb' in rentrez::entrez_fetch().

Usage

gb_record_get(id)

Arguments

Value

named vector of records, if no results found NULL

See Also

ncbi_acc_get()

Other get: gb_definition_get(), gb_fasta_get(), gb_organism_get(), gb_sequence_get(), gb_version_get()

Examples

library(restez)
restez_path_set(filepath = tempdir())
demo_db_create(n = 5)
(rec <- gb_record_get(id = 'demo_1'))
(recs <- gb_record_get(id = c('demo_1', 'demo_2')))


# delete demo after example
db_delete(everything = TRUE)

Description

Return the sequence(s) for a record(s) from the accession ID(s).

Usage

gb_sequence_get(id, dnabin = FALSE)

Arguments

Details

For more information about the dnabin format, see ape::DNAbin().

Value

named vector of sequences, if no results found NULL

See Also

ncbi_acc_get()

Other get: gb_definition_get(), gb_fasta_get(), gb_organism_get(), gb_record_get(), gb_version_get()

Examples

library(restez)
restez_path_set(filepath = tempdir())
demo_db_create(n = 5)
(seq <- gb_sequence_get(id = 'demo_1'))
(seqs <- gb_sequence_get(id = c('demo_1', 'demo_2')))
(fasta_dnabin <- gb_sequence_get(id = 'demo_1', dnabin = TRUE))

# delete demo after example
db_delete(everything = TRUE)

Description

Add records data.frame to SQL-like database.

Usage

gb_sql_add(df)

Arguments

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Generic query function for retrieving data from the SQL database for the get functions.

Usage

gb_sql_query(nm, id)

Arguments

Value

data.frame

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return the accession version for an accession ID.

Usage

gb_version_get(id)

Arguments

Value

named vector of versions, if no results found NULL

See Also

ncbi_acc_get()

Other get: gb_definition_get(), gb_fasta_get(), gb_organism_get(), gb_record_get(), gb_sequence_get()

Examples

library(restez)
restez_path_set(filepath = tempdir())
demo_db_create(n = 5)
(ver <- gb_version_get(id = 'demo_1'))
(vers <- gb_version_get(id = c('demo_1', 'demo_2')))


# delete demo after example
db_delete(everything = TRUE)

Description

Returns TRUE if the GenBank release number is the most recent GenBank release available.

Usage

gbrelease_check()

Value

logical

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Returns the GenBank release number. Returns empty character if none found.

Usage

gbrelease_get()

Details

If no file found, returns empty character vector.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

This function is called whenever db_download is run. It logs the GB release number in the 'gb_release.txt' in the user's restez path. The log is to help users keep track of whether their database if out of date.

Usage

gbrelease_log(release)

Arguments

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), has_data(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Returns TRUE if a restez SQL database has data.

Usage

has_data()

Value

Logical

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), identify_downloadable_files(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Searches through the release notes for a GenBank release to find all listed .seq files. Returns a data.frame for all .seq files and their description.

Usage

identify_downloadable_files()

Value

data.frame

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), last_add_get(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Determine whether an id(s) is/are present in a database.

Usage

is_in_db(id, db = "nucleotide")

Arguments

Value

named vector of booleans

See Also

Other database: count_db_ids(), db_create(), db_delete(), db_download(), demo_db_create(), list_db_ids()

Examples

library(restez)
# set the restez path to a temporary dir
restez_path_set(filepath = tempdir())
# create demo database
demo_db_create(n = 5)
# in the demo, IDs are 'demo_1', 'demo_2' ...
ids <- c('thisisnotanid', 'demo_1', 'demo_2')
(is_in_db(id = ids))


# delete demo after example
db_delete(everything = TRUE)

Description

Return the date and time of the last added sequence as determined using the 'add_log.tsv'.

Usage

last_add_get()

Details

If no file found, returns empty character vector.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_dwnld_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()

Description

Return the date and time of the last download as determined using the 'download_log.tsv'.

Usage

last_dwnld_get()

Details

If no file found, returns empty character vector.

Value

character

See Also

Other private: add_rcrd_log(), cat_line(), char(), check_connection(), cleanup(), connected(), connection_get(), db_download_intern(), db_sqlngths_get(), db_sqlngths_log(), dir_size(), dwnld_path_get(), dwnld_rcrd_log(), entrez_fasta_get(), entrez_gb_get(), extract_accession(), extract_by_patterns(), extract_clean_sequence(), extract_definition(), extract_features(), extract_inforecpart(), extract_keywords(), extract_locus(), extract_organism(), extract_seqrecpart(), extract_sequence(), extract_version(), file_download(), filename_log(), flatfile_read(), gb_build(), gb_df_create(), gb_df_generate(), gb_sql_add(), gb_sql_query(), gbrelease_check(), gbrelease_get(), gbrelease_log(), has_data(), identify_downloadable_files(), last_add_get(), last_entry_get(), latest_genbank_release_notes(), latest_genbank_release(), message_missing(), mock_def(), mock_gb_df_generate(), mock_org(), mock_rec(), mock_seq(), predict_datasizes(), readme_log(), restez_connect(), restez_disconnect(), restez_path_check(), restez_rl(), search_gz(), seshinfo_log(), setup(), slctn_get(), slctn_log(), sql_path_get(), status_class(), stat(), testdatadir_get()