CoLRev
Manual
Steps and operations
Workflow
Step 1: Problem formulation
Step 2: Metadata retrieval
Step 3: Metadata prescreen
Step 4: PDF retrieval
Step 5: PDF screen
Step 6: Data extraction and synthesis
Command-line Interface
Collaboration
Packages
Appendix
Developer documentation
Setup
Package development
Development status
API reference
colrev
colrev.constants
colrev.dataset
colrev.env
colrev.exceptions
colrev.exceptions.AppendOnlyViolation
colrev.exceptions.CleanRepoRequiredError
colrev.exceptions.CoLRevException
colrev.exceptions.CoLRevUpgradeError
colrev.exceptions.CorrectionPreconditionException
colrev.exceptions.CuratedOutletNotUnique
colrev.exceptions.DataException
colrev.exceptions.DedupeError
colrev.exceptions.DependencyConfigurationError
colrev.exceptions.DirtyRepoAfterProcessingError
colrev.exceptions.DuplicateIDsError
colrev.exceptions.FieldValueError
colrev.exceptions.GitConflictError
colrev.exceptions.GitNotAvailableError
colrev.exceptions.ImportException
colrev.exceptions.InvalidLanguageCodeException
colrev.exceptions.InvalidPDFException
colrev.exceptions.InvalidQueryException
colrev.exceptions.InvalidSettingsError
colrev.exceptions.MissingDependencyError
colrev.exceptions.MissingRecordQualityRuleSpecification
colrev.exceptions.NoRecordsError
colrev.exceptions.NoRecordsToImport
colrev.exceptions.NonEmptyDirectoryError
colrev.exceptions.NotEnoughDataToIdentifyException
colrev.exceptions.NotFeedIdentifiableException
colrev.exceptions.NotTOCIdentifiableException
colrev.exceptions.OriginError
colrev.exceptions.PDFHashError
colrev.exceptions.PackageParameterError
colrev.exceptions.PackageSettingMustStartWithPackagesException
colrev.exceptions.ParameterError
colrev.exceptions.PortAlreadyRegisteredException
colrev.exceptions.ProcessOrderViolation
colrev.exceptions.PropagatedIDChange
colrev.exceptions.RecordNotFoundException
colrev.exceptions.RecordNotFoundInPrepSourceException
colrev.exceptions.RecordNotInIndexException
colrev.exceptions.RecordNotInRepoException
colrev.exceptions.RecordNotInTOCException
colrev.exceptions.RecordNotIndexableException
colrev.exceptions.RecordNotParsableException
colrev.exceptions.RepoInitError
colrev.exceptions.RepoSetupError
colrev.exceptions.ReviewManagerNotNotifiedError
colrev.exceptions.SearchNotAutomated
colrev.exceptions.SearchSourceException
colrev.exceptions.ServiceNotAvailableException
colrev.exceptions.StatusFieldValueError
colrev.exceptions.StatusTransitionError
colrev.exceptions.TEIException
colrev.exceptions.TEITimeoutException
colrev.exceptions.TOCNotAvailableException
colrev.exceptions.TemplateNotAvailableError
colrev.exceptions.UnstagedGitChangesError
colrev.exceptions.UnsupportedImportFormatError
colrev.git_repo
colrev.hooks
colrev.loader
colrev.logger
colrev.ops
colrev.package_manager
colrev.packages
colrev.paths
colrev.process
colrev.record
colrev.review_manager
colrev.search_file
colrev.settings
colrev.ui_cli
colrev.utils
colrev.writer
colrev.ui_cli
colrev.hooks
colrev.review_manager
colrev.settings
colrev.ops
colrev.process
colrev.dataset
colrev.env
colrev.package_manager
colrev.constants
colrev.logger
colrev.exceptions
colrev.paths
colrev.loader
colrev.writer
colrev.record
Github repository
PyPI
Governance
CoLRev enhancement proposals (CEPs)
About
CoLRev
API reference
colrev
colrev.exceptions
colrev.exceptions.CleanRepoRequiredError
Edit on GitHub
colrev.exceptions.CleanRepoRequiredError
¶
exception
colrev.exceptions.
CleanRepoRequiredError
(
changedFiles
,
ignore_pattern
)
[source]
¶
A clean git repository would be required.