Column requirements of the tales consumers

What each function needs of a tales object. This is distinct from the class's own column contract, which says what makes an object valid: a valid tales may still lack what a given operation needs.

Usage

tales_requirements()

Value

A tibble of function, requirement kind, and columns.

Details

tales_compare_distal()

aa_seq or dna_seq (translated)

tales_align()

whichever of rvd / dom_code residue_col names

tales_rvd_strings()

rvd

tales_coded_strings()

dom_code

tales_domain_codes()

dom_code and aa_seq; rvd included when present

plot() on a tales

rvd, aa_seq, domain_type; seqnames adds a facet, alignment_position enables the aligned layout

See also

Other tales objects: [.tales(), as_tales(), format.tales(), format.tales_msa(), is_tales(), new_tales(), print.tales(), print.tales_msa(), summary.tales(), summary.tales_msa(), tales(), tales_anchor_codes(), tales_anomalies(), tales_assert_complete(), tales_bind(), tales_names(), tales_namespace(), validate_tales()

Examples

tales_requirements()
#> # A tibble: 8 × 3
#>   fn                   requirement columns                     
#>   <chr>                <chr>       <chr>                       
#> 1 plot.tales           all_of      rvd, aa_seq, domain_type    
#> 2 plot.tales           optional    seqnames, alignment_position
#> 3 tales_align          any_of      rvd, dom_code               
#> 4 tales_coded_strings  all_of      dom_code                    
#> 5 tales_compare_distal any_of      aa_seq, dna_seq             
#> 6 tales_domain_codes   all_of      dom_code, aa_seq            
#> 7 tales_domain_codes   optional    rvd                         
#> 8 tales_rvd_strings    all_of      rvd