docs: State the goals and non-goals - #58
Open
krlmlr wants to merge 2 commits into
Open
Conversation
This was referenced Sep 13, 2026
krlmlr
force-pushed
the
claude/readme-goals
branch
3 times, most recently
from
September 13, 2026 16:19
a13a218 to
357f99e
Compare
krlmlr
force-pushed
the
claude/readme-goals
branch
2 times, most recently
from
September 13, 2026 18:24
c08d9c2 to
ad0afd7
Compare
krlmlr
force-pushed
the
claude/readme-goals
branch
from
September 13, 2026 18:33
ad0afd7 to
7608894
Compare
krlmlr
force-pushed
the
claude/readme-goals
branch
from
September 13, 2026 20:33
7608894 to
77c2a5a
Compare
krlmlr
added this pull request to stack #63
September 13, 2026 21:41
The README now says, up front, what this package undertakes to do and what it leaves to others, so a reader can tell in a few seconds whether it is the right tool. The scope comes from the repository itself: the DESCRIPTION Title, Description and Imports; LazyData and the data/ directory; the LICENSE file, which records the copyright holder and licence of each data set; the source and reference sections of the dataset documentation; the exported surface in NAMESPACE, which is the lesmis_*() example-file accessors and the netzschleuder accessors and nothing else; and the limits that ns_metadata() and ns_df() enforce in R/netzschleuder.R. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
krlmlr
force-pushed
the
claude/readme-goals
branch
from
September 13, 2026 21:41
77c2a5a to
c13ab34
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds a "Goals and non-goals" section to the README, between the introduction and Installation, so a reader can tell in a few seconds whether this package is what they need.
README.mdandindex.mdcarry the same edit from the same render.Every bullet is grounded in this repository. The goals come from the DESCRIPTION Title and Description,
LazyData: truetogether with the eleven.rdafiles indata/, theLICENSEfile that records the copyright holder and licence of each data set separately from the package licence, the@sourceand@referencessections of each dataset's documentation, and the exported surface inNAMESPACE— thelesmis_*()example-file accessors and the netzschleuder accessors, and nothing else.The non-goals come from the same places. "Implement graph algorithms" follows from the Title, from igraph being an Import, and from an exported surface that contains no analysis function. "Generate networks" follows from the data sets being fixed files under
data/with no generator anywhere in the package. "Be an exhaustive catalogue" follows from the Description's own words, "a small collection", and from the netzschleuder accessors reaching a much larger collection that stays outside the package. "Download whole collections, or files of unbounded size" is a limit the code actually enforces:ns_metadata()aborts when asked to download a whole collection, andns_df()takes asize_limitargument defaulting to 1 GB.Considered and left out for want of evidence in this repository: anything about which igraph versions the stored graphs are compatible with beyond the
igraph (>= 2.0.0)requirement, and any claim about the package tracking upstream changes to the data.Verified: two consecutive renders are byte-identical, and the diff touches only
README.Rmd,README.mdandindex.md— noR/orman/file changes.🤖 Generated with Claude Code
https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
Generated by Claude Code