diff --git a/man/generateAllAlignments2FA.Rd b/man/generateAllAlignments2FA.Rd index 5babd22d..421d8cf7 100644 --- a/man/generateAllAlignments2FA.Rd +++ b/man/generateAllAlignments2FA.Rd @@ -22,18 +22,21 @@ generateAllAlignments2FA( \item{aln_path}{Character. Path to alignment files. Default is 'here("data/rawdata_aln/")'} -\item{fa_outpath}{Character. Path to the written fasta file. -Default is 'here("data/alns/")'.} - -\item{lin_file}{Character. Path to file. Master protein file with AccNum & +\item{fa_outpath}{Character. Path to file. Master protein file with AccNum & lineages. Default is 'here("data/rawdata_tsv/all_semiclean.txt")'} +\item{lin_file}{Character. Path to the written fasta file. +Default is 'here("data/alns/")'.} + \item{reduced}{Boolean. If TRUE, the fasta file will contain only one sequence per lineage. Default is 'FALSE'.} } \value{ +NULL. The function saves the output FASTA files to the specified +directory. + NULL. The function saves the output FASTA files to the specified directory. } @@ -47,6 +50,12 @@ Adding Leaves to an alignment file w/ accessions Adding Leaves to all alignment files w/ accessions & DAs? } \details{ +The alignment files would need two columns separated by spaces: +\enumerate{ +\item AccNum and 2. alignment. The protein homolog file should have AccNum, +Species, Lineages. +} + The alignment files would need two columns separated by spaces: \enumerate{ \item AccNum and 2. alignment. The protein homolog file should have AccNum, @@ -54,6 +63,9 @@ Species, Lineages. } } \note{ +Please refer to the source code if you have alternate + file formats +and/or column names. + Please refer to the source code if you have alternate + file formats and/or column names. } @@ -64,12 +76,6 @@ generateAllAlignments2FA() \dontrun{ generateAllAlignments2FA() } -\dontrun{ -generateAllAlignments2FA() -} -} -\author{ -Janani Ravi } \keyword{accnum,} \keyword{alignment,}