Dataverse: Documentation doesn't describe bibtex files in Dataverse bundles

[ross-spencer]

Thank you for contributing an issue to the Dataverse Project! If this is a bug report, please let us know when the issue occurs, which page it occurs on, to whom it occurs, and which version of Dataverse you're using. If this is a feature request, please let us know what you'd like to see and give us some context - what kind of user is the feature intended for, and what inspired the request? No matter the issue, screenshots are always welcome.

Related to archivematica/issues#152 we're trying to work out the structure of bundle files. Going by the docs here: http://guides.dataverse.org/en/latest/user/dataset-management.html?highlight=bundle there should only be six files but we are seeing a bibtex file emerging as part of a bundle as well. I am guessing that this is an as-yet undocumented enhancement to the bundle citation metadtata but it would be good to confirm and understand if we can help to update the Dataverse docs as a result.

Tabular Data Files

Files in certain formats - Stata, SPSS, R, Excel(xlsx) and CSV - may be 
ingested as tabular data (see “Tabular Data Ingest” section of the User Guide 
for details). Tabular data files can be further explored and manipulated with 
TwoRavens - a statistical data exploration application integrated with 
Dataverse, as well as other External Tools if they have been enabled in the 
installation of Dataverse you are using. TwoRavens allows the user to run 
statistical models, view summary statistics, download subsets of variable 
vectors and more. To start, click on the “Explore” button, found next to each 
relevant tabular file (the application will be opened in a new window). To 
download subsets of variables click on the “Download” button found next to a 
relevant tabular file and select “Data Subset” in the dropdown menu. You will 
then be able to create your subset using the interface opened in a new window 
(this functionality is also provided by the TwoRavens project). See the 
TwoRavens documentation section for more information.

Additional download options available for tabular data (found in the same 
drop-down menu under the “Download” button):

As tab-delimited data (with the variable names in the first row);

* The original file uploaded by the user;
* Saved as R data (if the original file was not in R format);
* Variable Metadata (as a DDI Codebook XML file);
* Data File Citation (currently in either RIS or EndNote XML format);
* All of the above, as a zipped bundle.

[pdurbin]

@ross-spencer hi! I'm not sure what you mean by "bundle" though I do see "zipped bundle" in the part of the docs you quoted. I feel like we usually just call this a "zip file" or something. Anyway, you can find a little more about BibTex support at http://guides.dataverse.org/en/4.9.2/user/find-use-data.html#cite-data . I'm sure you're right that the docs could be improved. Are you interested in making a pull request?

[ross-spencer]

Hi @pdurbin, that's interesting about the naming convention. We adopted it from the API call, .../api/access/datafile/bundle/<id> so it kinda stuck from there! :) Sure, I'll work up a PR, I think it's just a small addition so will try and get that to you within the week. It looks like that zip/package for tabular data will now contain all citation formats available with any dataset.

[pdurbin]

@ross-spencer ok, I didn't realize the citation formats are included in the zip. Thanks for offering to make a pull request! I just dragged this issue to "Community Dev" at https://waffle.io/IQSS/dataverse and you might find http://guides.dataverse.org/en/4.9.2/developers/documentation.html helpful when working on the guides. If you have any questions, please let us know!

[pdurbin]

@ross-spencer hi! Just checking in. Do you need a hand making the pull request? We're happy to help.

[ross-spencer]

Hi Philip - I should be okay - just short on time :) I can take another
look next week.

On Wed, Oct 17, 2018 at 2:03 PM Philip Durbin [e-mail]
wrote:

@ross-spencer https://github.com/ross-spencer hi! Just checking in. Do
you need a hand making the pull request? We're happy to help.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/IQSS/dataverse/issues/5081#issuecomment-430601057,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AByxXEMjcgdFk5dJY6SVoxIdl_ekXjbFks5ulxx6gaJpZM4W2Bc3
.

--
Ross Spencer
Software Developer, Artefactual Systems Inc.
www.artefactual.com

[pdurbin]

We plan to work on Bibtex some more in #5424.

@ross-spencer are you still interested in working on the docs? http://guides.dataverse.org/en/4.10/developers/documentation.html should help you get started and I'm happy to answer any questions! :smile:

[ross-spencer]

Hi Philip sorry, i have been pretty slack (and a pretty terrible contributor thus far!). We're in the midst of a release cycle of our own and I haven't found time yet. If someone takes it on then I don't mind, otherwise, I can see if I can squeeze it in. I did get as far as forking the repository and reading the docs! But that was before Christmas.

[pdurbin]

@ross-spencer no worries! Can you please tell me if the change at d5680cd I just made to pull request #5476 is enough for you to close this issue? I was on that branch anyway adding some tests and it's a pretty minor change. It looks like this:

[ross-spencer]

@pdurbin this is great! Thank you. If I grab a zip then I see this in the tree:

├── afternoon-snacks-1citation-bib.bib
├── afternoon-snacks-1citation-endnote.xml
├── afternoon-snacks-1citation-ris.ris
├── afternoon-snacks-1.csv
├── afternoon-snacks-1-ddi.xml
├── afternoon-snacks-1.tab

The doi for that is here: https://doi.org/10.5072/FK2/QAWS8O (but I think the Scholar's Portal team are currently performing maintenance)

So, I'd only question the or but if a bib file output needs to be configured on a Dataverse instance, or the docs need to be backward looking, then I think what you've got is just fine. We just point here when folk download it via Archivematica and say, this is what to expect.

[pdurbin]

@ross-spencer thanks but https://doi.org/10.5072/FK2/QAWS8O doesn't resolve anywhere. Do you have a direct link?

I'll leave it up to you to close this issue if you're happy with that commit I made earlier today. Or we can keep thinking about how to documented this stuff better. Thanks!

[ross-spencer]

I am hoping the link comes back - it will be on this Dataverse when it does: https://demodv.scholarsportal.info/

The commit looks good. Closing the ticket out. Thanks once again!