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

Acknowledge HDRUK Gateway in this package as a data source #175

Closed
Tracked by #171
RayStick opened this issue Jan 6, 2025 · 0 comments · Fixed by #176
Closed
Tracked by #171

Acknowledge HDRUK Gateway in this package as a data source #175

RayStick opened this issue Jan 6, 2025 · 0 comments · Fixed by #176
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@RayStick
Copy link
Member

RayStick commented Jan 6, 2025

https://devguide.ropensci.org/pkg_building.html

If your package connects to a data source or online service, or wraps other software, consider that your package README may be the first point of entry for users. It should provide enough information for users to understand the nature of the data, service, or software, and provide links to other relevant data and documentation. For instance, a README should not merely read, “Provides access to GooberDB,” but also include, “…, an online repository of Goober sightings in South America. More information about GooberDB, and documentation of database structure and metadata can be found at link”.

If your package provides access to a data source, we require that DESCRIPTION contains both (1) A brief identification and/or description of the organisation responsible for issuing data; and (2) The URL linking to public-facing page providing, describing, or enabling data access (which may often differ from URL leading directly to data source).

@RayStick RayStick mentioned this issue Jan 6, 2025
9 tasks
@RayStick RayStick added the documentation Improvements or additions to documentation label Jan 6, 2025
@RayStick RayStick added this to the rOpenSci Review Process milestone Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant