Suggest: doc and test `format_to_daisie_data`

[Richèl Bilderbeek]

Dear DAISIEmainland maintainer,

Thanks for DAISIEmainland and its many tested. It is great to see other people trying hard to generate simulations that are actually correct!

When checking the inner working of DAISIEmainland, however, I feel that sim_island_with_mainland is not one, but two black boxes, here I show what I mean in code:

sim_island_with_mainland <- function(
  # ...
) {
  # ...

  island_replicates <- list()

  # Black box 1: things with island replicates

  # Black box 2; format to DAISIE data
  island_replicates <- format_to_daisie_data(
    island_replicates = island_replicates,
    # ...  
  )

}

Now, it is acceptable that internal code is a bit of a black box. What is unexpected to me, however, is the lack of both tests and documentation of format_to_daisie_data.

Would it be possible to add documentation and/or tests for format_to_daisie_data to a precise reader such as I can get a feeling of what is going on?

Would be awesome!