ingewortel/artistoo Artistoo

CPM implementation in pure javascript (Node module)

#33 (all)
JavaScript (change)
24 seconds
5 days ago

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

JavaScript support is still young. Please report any mistakes Inch makes!
Seems really good
A
SoftConnectivityConstraint#postSetpixListener in /src/hamiltonian/SoftConnectivityConstraint.js Ne
A
ConnectivityConstraint#postSetpixListener in /src/hamiltonian/ConnectivityConstraint.js Ne
A
ActivityConstraint#postSetpixListener in /src/hamiltonian/ActivityConstraint.js Ne
A
PersistenceConstraint#setDirection in /src/hamiltonian/PersistenceConstraint.js Ne
A
GridBasedModel#setpixi in /src/models/GridBasedModel.js Ne
Show 201 more ...
Proper documentation present
B
Canvas#drawActivityValues in /src/Canvas.js E
B
PersistenceConstraint#sampleNorm in /src/hamiltonian/PersistenceConstraint.js E
B
PersistenceConstraint#randDir in /src/hamiltonian/PersistenceConstraint.js E
B
Canvas#drawFieldContour in /src/Canvas.js E
B
Canvas#drawField in /src/Canvas.js E
Show 4 more ...
Please take a look
Undocumented
U
MorpheusImport#setPreferredDirectionConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusImport#setConnectivityConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusImport#setPersistenceConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusWriter#setPreferredDirectionConstraint in /src/converter/MorpheusWriter.js E
U
MorpheusImport#setPerimeterConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusImport#setActivityConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusImport#setBarrierConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusWriter#multipleConstraintsWarning in /src/converter/MorpheusWriter.js E
U
MorpheusImport#setVolumeConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusWriter#setConnectivityConstraint in /src/converter/MorpheusWriter.js E
U
MorpheusImport#unknownConstraintWarning in /src/converter/MorpheusImport.js E
U
ModelDescription#getConstraintParameter in /src/converter/ModelDescription.js E
U
MorpheusWriter#setPersistenceConstraint in /src/converter/MorpheusWriter.js E
U
MorpheusWriter#setChemotaxisConstraint in /src/converter/MorpheusWriter.js E
U
MorpheusImport#readCoordinateAttribute in /src/converter/MorpheusImport.js E
U
ModelDescription#methodOverwriteError in /src/converter/ModelDescription.js E
U
ModelDescription#setGridConfiguration in /src/converter/ModelDescription.js E
U
MorpheusWriter#setPerimeterConstraint in /src/converter/MorpheusWriter.js E
U
ArtistooWriter#addConstraintToConfig in /src/converter/ArtistooWriter.js E
U
MorpheusWriter#setActivityConstraint in /src/converter/MorpheusWriter.js E
U
ModelDescription#initDimensionVector in /src/converter/ModelDescription.js E
U
MorpheusWriter#setBarrierConstraint in /src/converter/MorpheusWriter.js E
U
MorpheusWriter#writeCellPopulations in /src/converter/MorpheusWriter.js E
U
ModelDescription#initCellKindMatrix in /src/converter/ModelDescription.js E
U
ModelDescription#initCellKindVector in /src/converter/ModelDescription.js E
U
MorpheusWriter#toMorpheusCoordinate in /src/converter/MorpheusWriter.js E
U
MorpheusImport#setGridConfiguration in /src/converter/MorpheusImport.js E
U
ArtistooImport#setGridConfiguration in /src/converter/ArtistooImport.js E
U
MorpheusImport#setAdhesionMorpheus in /src/converter/MorpheusImport.js E
U
MorpheusImport#readMorpheusLattice in /src/converter/MorpheusImport.js E
U
ArtistooWriter#customMethodsString in /src/converter/ArtistooWriter.js E
U
MorpheusWriter#setVolumeConstraint in /src/converter/MorpheusWriter.js E
U
MorpheusImport#readVectorAttribute in /src/converter/MorpheusImport.js E
U
ModelDescription#setCellKindNames in /src/converter/ModelDescription.js E
U
ModelDescription#setGridGeometry in /src/converter/ModelDescription.js E
U
ArtistooWriter#setInitialisation in /src/converter/ArtistooWriter.js E
U
ArtistooWriter#writeBasicScript in /src/converter/ArtistooWriter.js E
U
MorpheusImport#parameterFromXML in /src/converter/MorpheusImport.js E
U
ArtistooImport#readPixelsByCell in /src/converter/ArtistooImport.js E
U
ModelDescription#setConstraints in /src/converter/ModelDescription.js E
U
MorpheusWriter#writeDescription in /src/converter/MorpheusWriter.js E
U
ArtistooImport#setCellKindNames in /src/converter/ArtistooImport.js E
U
MorpheusWriter#writeConstraints in /src/converter/MorpheusWriter.js E
U
MorpheusImport#setCellKindNames in /src/converter/MorpheusImport.js E
U
MorpheusImport#setCellPixelList in /src/converter/MorpheusImport.js E
U
Writer#recursiveArrayStringFix in /src/converter/Writer.js E
U
MorpheusWriter#setAttributesOf in /src/converter/MorpheusWriter.js E
U
ModelDescription#getConstraint in /src/converter/ModelDescription.js E
U
ModelDescription#setCPMGeneral in /src/converter/ModelDescription.js E
U
ArtistooWriter#addCustomMethod in /src/converter/ArtistooWriter.js E
U
ModelDescription#hasConstraint in /src/converter/ModelDescription.js E
U
ModelDescription#addConstraint in /src/converter/ModelDescription.js E
U
ModelDescription#setModelInfo in /src/converter/ModelDescription.js E
U
MorpheusWriter#writeCellTypes in /src/converter/MorpheusWriter.js E
U
ArtistooWriter#addInitializer in /src/converter/ArtistooWriter.js E
U
ArtistooImport#setConstraints in /src/converter/ArtistooImport.js E
U
MorpheusImport#setInitObjects in /src/converter/MorpheusImport.js E
U
ModelDescription#getKindIndex in /src/converter/ModelDescription.js E
U
MorpheusImport#setConstraints in /src/converter/MorpheusImport.js E
U
ModelDescription#setTimeInfo in /src/converter/ModelDescription.js E
U
MorpheusImport#setInitCircle in /src/converter/MorpheusImport.js E
U
MorpheusImport#addInitCircle in /src/converter/MorpheusImport.js E
U
MorpheusImport#addInitObject in /src/converter/MorpheusImport.js E
U
MorpheusWriter#writeAnalysis in /src/converter/MorpheusWriter.js E
U
ModelDescription#setGridInfo in /src/converter/ModelDescription.js E
U
ArtistooImport#setCPMGeneral in /src/converter/ArtistooImport.js E
U
ArtistooWriter#writeHTMLBody in /src/converter/ArtistooWriter.js E
U
ArtistooWriter#writeHTMLHead in /src/converter/ArtistooWriter.js E
U
MorpheusImport#setCPMGeneral in /src/converter/MorpheusImport.js E
U
ModelDescription#getKindName in /src/converter/ModelDescription.js E
U
ModelDescription#callerName in /src/converter/ModelDescription.js E
U
MorpheusImport#setModelInfo in /src/converter/MorpheusImport.js E
U
ArtistooImport#setModelInfo in /src/converter/ArtistooImport.js E
U
MorpheusImport#toCoordinate in /src/converter/MorpheusImport.js E
U
ArtistooWriter#writeConfig in /src/converter/ArtistooWriter.js E
U
ArtistooImport#setGridInfo in /src/converter/ArtistooImport.js E
U
MorpheusWriter#setAdhesion in /src/converter/MorpheusWriter.js E
U
MorpheusImport#setGridInfo in /src/converter/MorpheusImport.js E
U
ArtistooImport#setTimeInfo in /src/converter/ArtistooImport.js E
U
MorpheusImport#setTimeInfo in /src/converter/MorpheusImport.js E
U
MorpheusWriter#writeGlobal in /src/converter/MorpheusWriter.js E
U
MorpheusWriter#writeSpace in /src/converter/MorpheusWriter.js E
U
MorpheusWriter#attachNode in /src/converter/MorpheusWriter.js E
U
MorpheusImport#readXMLTag in /src/converter/MorpheusImport.js E
U
ArtistooWriter#writeHTML in /src/converter/ArtistooWriter.js E
U
MorpheusImport#getXMLTag in /src/converter/MorpheusImport.js E
U
MorpheusWriter#writeTime in /src/converter/MorpheusWriter.js E
U
MorpheusWriter#addNodeTo in /src/converter/MorpheusWriter.js E
U
ArtistooWriter#writeNode in /src/converter/ArtistooWriter.js E
U
MorpheusWriter#formatXml in /src/converter/MorpheusWriter.js E
U
MorpheusWriter#writeCPM in /src/converter/MorpheusWriter.js E
U
MorpheusWriter#writeXML in /src/converter/MorpheusWriter.js E
U
MorpheusWriter#makeNode in /src/converter/MorpheusWriter.js E
U
MorpheusWriter#initXML in /src/converter/MorpheusWriter.js E
U
ModelDescription#build in /src/converter/ModelDescription.js E
U
MorpheusWriter#setNode in /src/converter/MorpheusWriter.js E
U
CPM#getAllConstraints in /src/models/CPM.js E
U
ArtistooWriter#write in /src/converter/ArtistooWriter.js E
U
MorpheusWriter#write in /src/converter/MorpheusWriter.js E
U
Writer#objToString in /src/converter/Writer.js E
U
Writer#htmlNewLine in /src/converter/Writer.js E
U
Writer#stringWrap in /src/converter/Writer.js E
U
Writer#writeLog in /src/converter/Writer.js E
U
Writer#write in /src/converter/Writer.js E

Let's raise the visibility of documentation in Open Source!

This page is for ingewortel/artistoo and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.