Skip to content

Providing path examples in vignettes #167

@sdspieg

Description

@sdspieg

[Not sure whether it's 'kosher' to make suggestions for the documentation in github issues, but trying anyway]
The documentation of quanteda (and readtext) is impressive. But there are often small things that may be obvious to many more experienced users, but can be terribly frustrating for beginners. The vignettes nicely illustrate various use cases for types of files; but not for different locations - they all use DATA_DIR. [The doc says that "When reading in custom text files, you will need to determine your own data directory (see ?setwd()).", but I'm still looking for that as I write this[. But so maybe you could some different PATH use cases throughout your vignettes? For a Windows user wanting to read in one (very large) json file that's in a shared Google drive folder (what to use instead of paste0 then?); for a Mac user who wants to read a folder of txt files from one of their local folders; etc.
Just a suggestion!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions