Skip to content

Conversation

jhnwllr
Copy link
Collaborator

@jhnwllr jhnwllr commented Jun 24, 2025

@jhnwllr jhnwllr requested a review from Copilot June 24, 2025 10:30
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces the new lit_export() function to export GBIF literature records, updates related documentation, and adds tests to verify its behavior.

  • Add lit_export() implementation and export it in NAMESPACE
  • Extend documentation in man/lit_search.Rd and man/organizations.Rd
  • Add tests for lit_export() in tests/testthat/test-lit_search.R

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
tests/testthat/test-lit_search.R New tests covering various lit_export() usage scenarios
man/organizations.Rd Added 'installation' to data options and example invocation
man/lit_search.Rd Added alias, usage, and argument docs for lit_export()
R/lit_search.R Implemented lit_export(), updated lit_search() for abstracts
NAMESPACE Exported lit_export()
Comments suppressed due to low confidence (4)

man/lit_search.Rd:99

  • Documentation incorrectly states that 'abstract' is ignored for lit_search; the implementation actually respects the abstract parameter. Please update to reflect correct behavior.
Ignored for lit_search.}

R/lit_search.R:32

  • The roxygen note 'Ignored for lit_search' is inaccurate; either describe how abstract works here or note that it only applies to lit_export.
#' @param abstract (logical) should the abstract be included in the results. 

man/lit_search.Rd:52

  • The documentation lists curlopts defaulting to NULL, but the function signature uses list(). Update the docs to match the actual default.
  curlopts = NULL

R/lit_search.R:232

  • The new abstract argument in lit_search isn't covered by existing tests. Consider adding a test for lit_search(abstract=TRUE) to verify abstracts are included properly.
  data <- process_lit_async_results(ll,flatten=flatten,abstract=abstract)

jhnwllr and others added 5 commits June 24, 2025 12:34
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jhnwllr jhnwllr merged commit 91487ff into master Jun 24, 2025
7 checks passed
@jhnwllr jhnwllr deleted the lit_export branch June 24, 2025 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant