Documentation for attachment_link

[florianm]

Feature

Source https://github.com/ropensci/software-review/issues/335#issuecomment-596120460

I also noticed that attachment_link appears to be a place holder for functionality you intend to bring up in the future. It isn't demonstrated in the vignettes, and it has a TODO note in it that indicates that you will be improving this function to use the form schema to find attachment fields, like you did for ru_datatime. I am not sure the best approach here, but I think it's worth considering putting this in a development branch for now if it is not fully implemented. I might be wrong about your intentions here, so pardon me if that is the case. Would it make sense to do what this function does when a user calls handle_ru_attachments?

[florianm]

• submission_export exports a ZIP archive of all submissions as CSV, plus all attachment media.
• attachment_link prepends the attachment filenames in the CSV with the attachment media folder.

The TODO note refers to the intent to introspect the form_schema to find column names of attachment files. This is now implemented as follows:

• attachment_link introspects form_schema to get attachment field names
• attachment_link params: added form_schema, dropped att_contains

attachment_link usage is (still) demonstrated in examples and (updated) in vignette "restful-api" under "submission_export".