airr-community / airr-standards

AIRR Community Data Standards
https://docs.airr-community.org
Creative Commons Attribution 4.0 International
35 stars 23 forks source link

v1.4 doc updates #633

Closed schristley closed 1 year ago

javh commented 2 years ago

I just pushed final (from my perspective) edits to the R and python library docs. Build is here: https://docs.airr-community.org/en/doc-1.4-fixes/

I made one actual change to the interface functions in the libraries, which was to rename the adf argument to model under the reasoning that the name and purpose of DataFile may change in v2.0. I don't love the name model, but it will let us convert it from a boolean to a string so we can do stuff like model="DataFile", model="Manifest", etc for different use cases without breaking backwards compatibility for the default behavior (which is currently what's in DataFile). I don't know what we'll do with all that for v2.0 - just trying to future proof against argument name changes.