Clean code in parse_citation.R #221
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- put assignment between bibentry and schema into new function bibentry_to_schema_field().
- codemeta was only used to get the "author" field, so there is no need to save it in a variable. - Instead, assign "author" (renamed from "authors") directly. - Move comment about bibentry types towards bibentry_to_schema_field()
parse_citation() - Extract determination of type into new function bibentry_to_schema_field() - Extract determination of id (URL of doi.org resource) into new function to_url_doi_or_null() - Split the rest into two main functions: init_citation() and parse_journal() - always paste the result of parse_journal() with c() to the initialised citation. As it may be NULL, citation may not alter if it does not refer to a journal article. No need for an extra if(). to_url_doi_or_null() - Return early if there is no doi or if doi already is (better: looks like) a doi.org-URL - Use new function get_url_doi() to generate the URL - No need for "else" as we always return() init_citation() - Already include "@id" and "sameAs" in the list(). These entries will be removed by the surrounding drop_null() in case that id is NULL. parse_journal() - Return NULL if this is not a journal bibentry. - By doing it here, the upper level code can be clearer. The result may be used directly in c(x, result) and x will not change if result is NULL. guess_citation() - Use existing helper function installed_package_names(). Create the path to CITATION only once and store it in citation_file - Create intermediate logical variables to improve readability - Return early with NULL if there is neither a citation file nor is the package installed - Encapsulate reading of the citation file into new function read_citation_with_encoding() read_citation_with_encoding() - Call utils::readCitationFile() only once with meta being either NULL or a list with element "Encoding".
|
@maelle this looks good to me (I restarted the stalled travis build as well) |
maelle
added a commit
that referenced
this pull request
Apr 1, 2020
## Deprecation * The use_git_hook argument of write_codemeta() has been deprecated. Solutions for keeping DESCRIPTION and codemeta.json in sync are available in the docs. ## Enhancements * Docs were improved to make a better case for codemetar. * Changes in the way codeRepository is guessed. codemetar can now recognize an URL from GitHub, GitLab, Bitbucket, R-Forge among several URLs in DESCRIPTION, to assign it to codeRepository. If no URL in DESCRIPTION is from any of these providers, `guess_github()` is called. * Adds documentation of internet needs and verbosity to steps downloading information from the web (#270, @Bisaloo) * New argument `write_minimeta` for `write_codemeta()` indicating whether to also create the file schemaorg.json that corresponds to the metadata Google would validate, to be inserted to a webpage for SEO. It is saved as "schemaorg.json" alongside `path` (by default, "codemeta.json"). This functionality requires the `jsonld` package (listed under `Suggests`). ## Bug fixes * Fix for detecting rOpenSci review badge (@sckott, #236) * Fix extraction of ORCID when composite comment (@billy34, #231) * Fix bug in crosswalking (#243) * Bug fix: the codeRepository is updated if there's any URL in DESCRIPTION. * Bug fix: the README information is now updated by codemeta_readme(). Previously if e.g. a developmentStatus had been set previously, it was never updated. ## Internals * Code cleaning following the book Martin, Robert C. Clean code: a handbook of agile software craftsmanship. Pearson Education, 2009. (@hsonne, #201, #202, #204, #205, #206, #207, #209, #210, #211, #212, #216, #218, #219, #220, #221). * Use of re-usable Rmd pieces for the README, intro vignette and man pages to reduce copy-pasting.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just another cleaned file, see commit messages... Thanks for review, Hauke