search

IntegralEnvision / integral

Package for Integral functions
https://integralenvision.github.io/integral/
Other
0 stars 0 forks source link

create ic_write_excel_wlog() #84

Open atyrell3 opened 1 year ago

atyrell3 commented 1 year ago

There are some Excel features that allow for more flexible project documentation than what can be achieved with .csv files, such as the ability to add a notice in the header if the data is confidential (this could even be incorporated into the function as an automatic addition to any files being saved). Therefore, some projects would benefit from the ability to save an Excel file with associated updates to the file_log.csv. I can develop this feature if people agree that it should be a priority.

jzadra commented 1 year ago

What is the use case for this excel output? Continued machine readable data for scripted analyses? Or just human readers?

As for the log, that seems like a good idea regardless but it could be as simple as just wrapping one of the existing excel writing functions (we should discuss which if we do this to get a consensus on our preferred option).

Several of us, most recently myself and @bleonard314, have been working on code that creates integral formatted excel tables, including headers and footers. It has a lot of options, so maybe it's overkill for just adding some metadata or notes, but regardless much of the code could be reused (or a simplified alias of the function could be created), but I'm also hesitant to have multiple functions that write excel tables as it could get confusing to users.

kheal commented 1 year ago

I think this is a great idea. It's related to #61, which I have not found time to address. My vote is that we use whatever excel-writer we are using in the ic_qa function. I think this is completely separate from the Integral formatted excel tables and we shouldn't wait for that functionality to have an ic_write_excel_wlog() function.