concatipede_example {concatipede}R Documentation

Get the path to one of concatipede example files

Description

Several example files are shipped with the concatipede package. This function facilitates the access to those files.

Usage

concatipede_example(example_file = NULL)

Arguments

example_file

Basename of the target example file. If NULL (the default), the basenames of the available files are listed.

Details

COI_Macrobiotidae.fas

Example fasta file.

ITS2_Macrobiotidae.fas

Example fasta file.

LSU_Macrobiotidae.fas

Example fasta file.

SSU_Macrobiotidae.fas

Example fasta file.

sequences-test-matching.xlsx

This is an Excel file (extension .xlsx) typically used to test or demonstrate the automatic matching capabilities of the concatipede package. This file represents the Excel template that could be produced by concatipede_prepare after detecting the fasta files present in a working directory.

Macrobiotidae_seqnames.xlsx

This is an Excel file (extension .xlsx) that contains the correspondence table that can be used to concatenate the sequences contained in the example fasta files COI_Macrobiotidae.fas, ITS2_Macrobiotidae.fas, LSU_Macrobiotidae.fas, and SSU_Macrobiotidae.fas.

Value

The full path to access the example file, or a list of available example files if no example_file argument was provided.

Examples

concatipede_example()
example <- concatipede_example("sequences-test-matching.xlsx")
if (requireNamespace("readxl")) {
  seqs <- readxl::read_xlsx(example)
  seqs
}


[Package concatipede version 1.0.1 Index]