Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bibtype field to methods table #192

Closed
ehwenk opened this issue Jan 14, 2025 · 2 comments
Closed

Add bibtype field to methods table #192

ehwenk opened this issue Jan 14, 2025 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@ehwenk
Copy link
Collaborator

ehwenk commented Jan 14, 2025

As described here, it would be useful for traits.build database users to be able to filter data based on citation type (e.g. Unpublished, Database, Article, Online, Thesis). This information is documented within the metadata files and is interpreted by RefManageR functions (WriteBib, asBibEntry), but is not currently documented in any field within the traits.build database structure. During the reading of the dataset metadata.yml files this information should be documented in a column within the methods table for easy filtering.

Thanks to @bmedlyn for catching this omission.

@ehwenk ehwenk self-assigned this Jan 14, 2025
@ehwenk ehwenk added this to AusTraits Jan 14, 2025
@ehwenk ehwenk moved this to Backlog in AusTraits Jan 14, 2025
@ehwenk ehwenk added the enhancement New feature or request label Jan 14, 2025
@ehwenk
Copy link
Collaborator Author

ehwenk commented Jan 14, 2025

Implemented through this commit.

austraits functions work with the updated output structure, although it will eventually be necessary to update austraits tests.

@ehwenk ehwenk moved this from Backlog to Done in AusTraits Jan 14, 2025
@ehwenk ehwenk closed this as completed by moving to Done in AusTraits Jan 14, 2025
@ehwenk ehwenk moved this from Done to In Progress in AusTraits Jan 14, 2025
@ehwenk ehwenk reopened this Jan 14, 2025
ehwenk added a commit that referenced this issue Jan 15, 2025
As described [here](#192), the `BibType ` associated with a dataset is used by the R package `RefManageR` to process the references, but is not displayed anywhere within the traits.build database. A column recording the BibType of the
primary citation is now included within the reference table. 
This change has not effected any dataset metadata.yml files, but is
simply capturing and outputting data that was already documented in
them.

Note that `austraits` functions still work and the function
`extract_data` lets you filter data based on `BibType`.
@ehwenk
Copy link
Collaborator Author

ehwenk commented Jan 29, 2025

closed with commit e825a40

@ehwenk ehwenk closed this as completed Jan 29, 2025
@github-project-automation github-project-automation bot moved this from In Progress to Done in AusTraits Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

1 participant