Package ‘taxa’ - R .taxa-package taxa Description The taxa package is intended to: ... For many

  • View
    212

  • Download
    0

Embed Size (px)

Text of Package ‘taxa’ - R .taxa-package taxa Description The taxa package is intended to: ... For many

  • Package taxaAugust 9, 2018

    Type Package

    Title Taxonomic Classes

    Description Provides taxonomic classes forgroupings of taxonomic names without data, and thosewith data. Methods provided are ``taxonomically aware'', inthat they know about ordering of ranks, and methods thatfilter based on taxonomy also filter associated data.

    Version 0.3.1

    Depends R (>= 3.0.2)

    VignetteBuilder knitr

    LazyLoad yes

    LazyData yes

    License MIT + file LICENSE

    URL https://github.com/ropensci/taxa

    BugReports https://github.com/ropensci/taxa/issues

    Imports R6, jsonlite, dplyr, lazyeval, magrittr, tibble, knitr, rlang,stringr, crayon, tidyr, utils, taxize

    Suggests roxygen2 (>= 6.0.1), testthat, rmarkdown (>= 0.9.6)

    RoxygenNote 6.0.1

    X-schema.org-applicationCategory Taxonomy

    X-schema.org-keywords taxonomy, biology, hierarchy

    X-schema.org-isPartOf https://ropensci.org

    NeedsCompilation no

    Author Scott Chamberlain [aut] (),Zachary Foster [aut, cre] ()

    Maintainer Zachary Foster

    Repository CRAN

    Date/Publication 2018-08-08 22:00:02 UTC

    1

    https://github.com/ropensci/taxahttps://github.com/ropensci/taxa/issues

  • 2 R topics documented:

    R topics documented:taxa-package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3all_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7arrange_obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8arrange_taxa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9branches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10classifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11database_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12extract_tax_data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12ex_hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15ex_hierarchy1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16ex_hierarchy2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16ex_hierarchy3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17ex_taxmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17ex_taxonomy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18filtering-helpers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18filter_obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20filter_taxa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22get_data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24get_dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25get_data_frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28highlight_taxon_ids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30id_classifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30internodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31is_branch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32is_internode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33is_leaf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33is_root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34is_stem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35leaves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36leaves_apply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37lookup_tax_data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38map_data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41map_data_ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42mutate_obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43n_leaves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44n_leaves_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45n_obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45n_obs_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46n_subtaxa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47n_subtaxa_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48n_supertaxa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49n_supertaxa_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50obs_apply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

  • taxa-package 3

    parse_dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52parse_tax_data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53pick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58print_tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59ranks_ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60remove_redundant_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60replace_taxon_ids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61roots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61sample_frac_obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62sample_frac_taxa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64sample_n_obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65sample_n_taxa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66select_obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68span . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69stems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71subtaxa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72subtaxa_apply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73supertaxa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74supertaxa_apply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76taxa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77taxmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78taxon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81taxonomy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83taxonomy_table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85taxon_database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86taxon_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87taxon_ids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88taxon_indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88taxon_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89taxon_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90taxon_rank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91taxon_ranks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92transmute_obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

    Index 94

    taxa-package taxa

    Description

    The taxa package is intended to:

    Provide a set of classes to store taxonomic data and any user-specific data associated with it

    Provide functions to convert commonly used formats to these classes

    Provide a common foundation for other packages to build on to enable an ecosystem of com-patible packages dealing with taxonomic data.

  • 4 taxa-package

    Provide generally useful functionality, such as filtering and mapping functions

    Main classes

    These are the classes users would typically interact with:

    taxon: A class used to define a single taxon. Many other classes in the taxa package includeone or more objects of this class.

    taxa: Stores one or more taxon objects. This is just a thin wrapper for a list of taxon objects.

    hierarchy: A class containing an ordered list of taxon objects that represent a hierarchicalclass