diffdf icon indicating copy to clipboard operation
diffdf copied to clipboard

enhance the file output

Open kieranjmartin opened this issue 6 years ago • 3 comments

I was thinking that if you are outputting a file it's probably because you want an audit trail. Currently all they get is "no issues found!".

Ideally I'd want something like:

Date:X, OS:X, Version of R: Y, libraries loaded:Z. File name: A

Comparison of objects DS1 and qc_DS1 had the following findings:

No issues found.

kieranjmartin avatar Aug 30 '18 10:08 kieranjmartin

I can't make up my mind on this one,

I can see where you are coming from in terms of wanting to output a complete file that contains nice audit level information but on the other hand I kinda feel the use should be left in charge of whats appropriate to include for their use case.

For example they may also want git commit numbers or company/user Ids. In this regard its easier to just leave it as is and let them customise themselves.

gowerc avatar Mar 25 '19 14:03 gowerc

Hmm, that's true, i guess they can just build round it fairly easily, so maybe it's fine.

kieranjmartin avatar Mar 25 '19 15:03 kieranjmartin

Though again if they wanted to full customise it they could just do it as part of a sink process:

sink( "./someFile.txt")
print( headerinfo)
print(diffdf_object)
print( footerinfo)
sink()

I guess if someone is using the file = option they are more likely looking for a mini report. Urgh I'm not sure about this one.

gowerc avatar Mar 25 '19 15:03 gowerc