traitecoevo / APCalign

R package for accessing, matching and updating species names of Australian flora
https://traitecoevo.github.io/APCalign/
Other
4 stars 6 forks source link

Add messages summarising alignments and updates #131

Open ehwenk opened 1 year ago

ehwenk commented 1 year ago

After running create_taxonomic_update_lookup it would be good to print out some summary statistics, so the user has a sense of the changes that were made.

For instance: x taxa aligned with APC-accepted species x taxa aligned with APC-accepted genera x taxa aligned with APNI recorded names x taxa could not be aligned to a known genus or species x aligned taxon names were updated to APC-accepted species you chose the most_likely_species option for the parameter taxonomic_splits. The column ... documents other possible names. etc.

fontikar commented 4 months ago

@ehwenk to simplify or ditch messaging for load_taxonomic_resources and during alignment . In the future we will enhance the the messaging to update during matching

ehwenk commented 4 months ago

For now I propose commenting out lines 166-176 in align_taxa.R. There is still the message from line 79 that indicates how many taxa are in the list.

message("Checking alignments of ", dplyr::n_distinct(original_name, na.rm = TRUE), " taxa\n")

The options going forward are for: 1) Summary statistics that are added at the end 2) Summary statistics that are added after each algorithm (or cluster of algorithms) that indicate how many taxa have been matched, but those messages would need to be embedded within match_taxa.R - and maybe is something to do if we modularise the function?