document rules for naming functions

[taylorreiter]

Naming functions

Functions that are exported (e.g. user-facing) are named by the action completed by the function, the sourmash output type the act on, and if relevant, a description of the action taken.

• Action words:
  • read
  • plot
  • from
• sourmash output types:
  • signature
  • compare_csv
  • gather
  • taxonomy_annotate
• example actions:
  • to_metacoder
  • upset
  • heatmap
  • mds

Functions that are not exported do not follow a naming scheme but strive to be fully descriptive of their actions, and when possible use the sourmash output types to make it clear what type of data the internal function operates on.

• examples of internal functions
  • check_compare_df_sample_col_and_move_to_rowname()
  • check_and_edit_names_in_signatures_df()
  • check_uniform_parameters_in_signatures_df()
  • make_agglom_cols()
  • make_expression()
  • get_scaled_for_max_hash()
  • pivot_wider_taxonomy_annotate()

[taylorreiter]

22 changes taxonomy_annotate_to_metacoder() to from_taxonomy_annotate_to_metacoder(). Now need to do the mds one.

[taylorreiter]

This can probably be added to the dev docs and then the issue closed

[taylorreiter]

Closing bc added to dev docs