Skip to content

tecosaur/DataToolkitDocumenter.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DataToolkitDocumenter.jl

This is a tiny package that allows data sets to be documented in the same manner as functions/variables.

https://user-images.githubusercontent.com/20903656/253025150-bf3451e1-bc2b-42b3-b9fb-985e816a2614.png

Recognised dataset parameters

  • description
  • licence / license
  • creator
  • date
  • doi
  • webpage

Usage

Add DataToolkitDocumenter along with Documenter when generating the documentation, and ensure that any data collection(s) you want to document are loaded.

In the documentation source files themselves, use @datasets in the same manner as @docs to document some data sets by their identifier, e.g.

```@datasets
iris
[other identifiers...]
```

For documenting an entire data collection with ease, one can use @autodatasets. With no content it will document the first collection on the stack, but specific collections can be documented by setting a Collections value, like so:

```@autodatasets
Collections = [nothing, "foo", "bar", "ded0d04d-deda-4bd8-95cb-5b214a5e3ce6"]
```

The value of nothing is special, and refers to the top entry of the data collection stack. Other collections can be referenced by name or UUID.

About

Document your data sets

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages