Closed dyf closed 4 years ago
I took a look through the docs.
landing:
[x] landing page says ipfx is python 2/3. We only support 3 now
[x] (nice to have) bolded class names in text should be links to apidocs
[x] the "analyze a data set" section should use the new dataset constructor
[x] the "analysis pipeline" section should be fleshed out and its value for external users described
[x] Describe package's function in more detail at the beginning. It should answer the question of "How this package could be useful to me?" rather than describing what we did here at Allen. Which features can package compute and for which stimuli? Link to list of features.
[x] Instead of saying "software is designed for use in the Allen Institute for Brain Science electrophysiology data processing pipeline" list how it could be used at different scales of processing. From single t v i sweeps to building a processing pipeline
[x] In Stimulus Specific Analysis introduce Sweep before Sweep_Set
[x] add QC example. QC is mentioned but no example is given
[x] In Analysis Pipeline introduce the notion of a pipeline as a next step in the scaling of the ipfx usage. Remove references to particular scripts (e.g, sweep_extraction). They are described in detail on a Pipeline page.
[x] Questions section on the left-hand side is AllenSDK specific. Is that a part of the template that cannot be changed?
[x] Liming the landing page to description of what the package is doing. Move all quick examples (the how) to the separate QuickStart page. Add to the QuickStart Page the example of running the DataSet rather than having it in a separate page.
[x] Restructure the "Dataset and Stimuli" page to make it largely about stimuli describing different stimuli types (ideally with plots) and the intricacies of the stimulus_ontology
[ ] Add new page describing how to download data. Any way to access data from dandi based on specimen_id??
Api Documentation
installation:
git-lfs
is needed to get our test datacredits:
data sets and stimuli:
gallery of examples: Some of these could use:
qc and analysis pipeline:
api documentation:
history:
README.md:
How to install and use ipfx Links to examples Link to ipfx.readthedocs.io